diff --git a/gcloud/_version b/gcloud/_version index 48b54aa21..9111d522b 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 414.0.0 -alpha 2023.01.13 -beta 2023.01.13 +Google Cloud SDK 415.0.0 +alpha 2023.01.20 +beta 2023.01.20 bq 2.0.84 bundled-python3-unix 3.9.16 -core 2023.01.13 +core 2023.01.20 gcloud-crc32c 1.0.0 gsutil 5.18 diff --git a/gcloud/access-context-manager/authorized-orgs/list b/gcloud/access-context-manager/authorized-orgs/list index 7d161a35d..9d2a25e9e 100644 --- a/gcloud/access-context-manager/authorized-orgs/list +++ b/gcloud/access-context-manager/authorized-orgs/list @@ -8,7 +8,7 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List all service access zones in an access policy object. + List all authorized organizations descriptions in an access policy object. EXAMPLES To list authorized organizations description in an access policy, run: diff --git a/gcloud/ai/custom-jobs/create b/gcloud/ai/custom-jobs/create index 593094e1c..40001efa1 100644 --- a/gcloud/ai/custom-jobs/create +++ b/gcloud/ai/custom-jobs/create @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud ai custom-jobs create --display-name=DISPLAY_NAME (--config=CONFIG --worker-pool-spec=[WORKER_POOL_SPEC,...]) - [--args=[ARG,...]] [--command=[COMMAND,...]] [--enable-web-access] + [--args=[ARG,...]] [--command=[COMMAND,...]] + [--enable-dashboard-access] [--enable-web-access] [--labels=[KEY=VALUE,...]] [--network=NETWORK] [--python-package-uris=[PYTHON_PACKAGE_URIS,...]] [--region=REGION] [--service-account=SERVICE_ACCOUNT] @@ -166,6 +167,12 @@ OPTIONAL FLAGS Command to be invoked when containers are started. It overrides the entrypoint instruction in Dockerfile when provided. + --enable-dashboard-access + Whether you want Vertex AI to enable dashboard built on the training + containers. If set to true, you can access the dashboard at the URIs + given by CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + --enable-web-access Whether you want Vertex AI to enable interactive shell access (https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) diff --git a/gcloud/ai/hp-tuning-jobs/create b/gcloud/ai/hp-tuning-jobs/create index 34f8fdb7f..280a670fa 100644 --- a/gcloud/ai/hp-tuning-jobs/create +++ b/gcloud/ai/hp-tuning-jobs/create @@ -3,8 +3,8 @@ NAME SYNOPSIS gcloud ai hp-tuning-jobs create --config=CONFIG --display-name=DISPLAY_NAME - [--algorithm=ALGORITHM] [--enable-web-access] - [--labels=[KEY=VALUE,...]] + [--algorithm=ALGORITHM] [--enable-dashboard-access] + [--enable-web-access] [--labels=[KEY=VALUE,...]] [--max-trial-count=MAX_TRIAL_COUNT; default=1] [--network=NETWORK] [--parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1] [--region=REGION] [--service-account=SERVICE_ACCOUNT] @@ -60,6 +60,12 @@ OPTIONAL FLAGS Search algorithm specified for the given study. ALGORITHM must be one of: algorithm-unspecified, grid-search, random-search. + --enable-dashboard-access + Whether you want Vertex AI to enable dashboard built on the training + containers. If set to true, you can access the dashboard at the URIs + given by CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + --enable-web-access Whether you want Vertex AI to enable interactive shell access (https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) diff --git a/gcloud/ai/models/upload b/gcloud/ai/models/upload index 807a1430d..33f94864b 100644 --- a/gcloud/ai/models/upload +++ b/gcloud/ai/models/upload @@ -101,6 +101,9 @@ OPTIONAL FLAGS Resource name of the model into which to upload the version. Only specify this field when uploading a new version. + Value should be provided in format: + projects/PROJECT_ID/locations/REGION/models/PARENT_MODEL_ID + Region resource - Cloud region to upload model. 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: diff --git a/gcloud/alpha/access-context-manager/authorized-orgs/list b/gcloud/alpha/access-context-manager/authorized-orgs/list index f74c50994..afcfc8bde 100644 --- a/gcloud/alpha/access-context-manager/authorized-orgs/list +++ b/gcloud/alpha/access-context-manager/authorized-orgs/list @@ -8,7 +8,8 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List all service access zones in an access policy object. + (ALPHA) List all authorized organizations descriptions in an access policy + object. EXAMPLES To list authorized organizations description in an access policy, run: diff --git a/gcloud/alpha/ai/custom-jobs/create b/gcloud/alpha/ai/custom-jobs/create index 316b16031..45f241057 100644 --- a/gcloud/alpha/ai/custom-jobs/create +++ b/gcloud/alpha/ai/custom-jobs/create @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha ai custom-jobs create --display-name=DISPLAY_NAME (--config=CONFIG --worker-pool-spec=[WORKER_POOL_SPEC,...]) - [--args=[ARG,...]] [--command=[COMMAND,...]] [--enable-web-access] + [--args=[ARG,...]] [--command=[COMMAND,...]] + [--enable-dashboard-access] [--enable-web-access] [--labels=[KEY=VALUE,...]] [--network=NETWORK] [--python-package-uris=[PYTHON_PACKAGE_URIS,...]] [--region=REGION] [--service-account=SERVICE_ACCOUNT] @@ -167,6 +168,12 @@ OPTIONAL FLAGS Command to be invoked when containers are started. It overrides the entrypoint instruction in Dockerfile when provided. + --enable-dashboard-access + Whether you want Vertex AI to enable dashboard built on the training + containers. If set to true, you can access the dashboard at the URIs + given by CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + --enable-web-access Whether you want Vertex AI to enable interactive shell access (https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) diff --git a/gcloud/alpha/ai/hp-tuning-jobs/create b/gcloud/alpha/ai/hp-tuning-jobs/create index 51e34f326..deedfbc6c 100644 --- a/gcloud/alpha/ai/hp-tuning-jobs/create +++ b/gcloud/alpha/ai/hp-tuning-jobs/create @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha ai hp-tuning-jobs create --config=CONFIG --display-name=DISPLAY_NAME [--algorithm=ALGORITHM] - [--enable-web-access] [--labels=[KEY=VALUE,...]] + [--enable-dashboard-access] [--enable-web-access] + [--labels=[KEY=VALUE,...]] [--max-trial-count=MAX_TRIAL_COUNT; default=1] [--network=NETWORK] [--parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1] [--region=REGION] [--service-account=SERVICE_ACCOUNT] @@ -60,6 +61,12 @@ OPTIONAL FLAGS Search algorithm specified for the given study. ALGORITHM must be one of: algorithm-unspecified, grid-search, random-search. + --enable-dashboard-access + Whether you want Vertex AI to enable dashboard built on the training + containers. If set to true, you can access the dashboard at the URIs + given by CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + --enable-web-access Whether you want Vertex AI to enable interactive shell access (https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) diff --git a/gcloud/alpha/ai/models/upload b/gcloud/alpha/ai/models/upload index eb73178d5..b4dc33174 100644 --- a/gcloud/alpha/ai/models/upload +++ b/gcloud/alpha/ai/models/upload @@ -147,6 +147,9 @@ OPTIONAL FLAGS Resource name of the model into which to upload the version. Only specify this field when uploading a new version. + Value should be provided in format: + projects/PROJECT_ID/locations/REGION/models/PARENT_MODEL_ID + Region resource - Cloud region to upload model. 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: diff --git a/gcloud/alpha/blockchain-node-engine/help b/gcloud/alpha/blockchain-node-engine/help index 481411b5e..fe95574db 100644 --- a/gcloud/alpha/blockchain-node-engine/help +++ b/gcloud/alpha/blockchain-node-engine/help @@ -20,8 +20,11 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + locations + (ALPHA) View Blockchain Node Engine locations available for a project. + nodes - (ALPHA) List blockchain nodes. + (ALPHA) Commands for viewing and manipulating blockchain nodes. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/blockchain-node-engine/locations/describe b/gcloud/alpha/blockchain-node-engine/locations/describe new file mode 100644 index 000000000..3d72283d8 --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/locations/describe @@ -0,0 +1,56 @@ +NAME + gcloud alpha blockchain-node-engine locations describe - describe a + Blockchain Node Engine location + +SYNOPSIS + gcloud alpha blockchain-node-engine locations describe [LOCATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Blockchain Node Engine location. + + To get a list of available locations for your project run: + + $ gcloud alpha blockchain-node-engine locations list + +EXAMPLES + The following command describes Blockchain Node Engine location + us-central1: + + $ gcloud alpha blockchain-node-engine locations describe us-central1 + +POSITIONAL ARGUMENTS + Location resource - The Blockchain Node Engine location you want to + describe. This represents a Cloud resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument location on the command line with a fully + specified name; + ◆ set the property web3/location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + [LOCATION] + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument location on the command line; + ▸ set the property web3/location. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the blockchainnodeengine/v1alpha1 API. The full + documentation for this API can be found at: https://cloud.google.com/web3 + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. + diff --git a/gcloud/alpha/blockchain-node-engine/locations/help b/gcloud/alpha/blockchain-node-engine/locations/help new file mode 100644 index 000000000..a1c8668cb --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/locations/help @@ -0,0 +1,31 @@ +NAME + gcloud alpha blockchain-node-engine locations - view Blockchain Node Engine + locations available for a project + +SYNOPSIS + gcloud alpha blockchain-node-engine locations COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) View Blockchain Node Engine locations available for a project. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe a Blockchain Node Engine location. + + list + (ALPHA) List available Blockchain Node Engine locations. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. + diff --git a/gcloud/alpha/blockchain-node-engine/locations/list b/gcloud/alpha/blockchain-node-engine/locations/list new file mode 100644 index 000000000..471c9effb --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/locations/list @@ -0,0 +1,62 @@ +NAME + gcloud alpha blockchain-node-engine locations list - list available + Blockchain Node Engine locations + +SYNOPSIS + gcloud alpha blockchain-node-engine locations list [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List available Blockchain Node Engine locations. + +EXAMPLES + The following command lists all of the locations where Blockchain Node + Engine nodes are available: + + $ gcloud alpha blockchain-node-engine locations list + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the blockchainnodeengine/v1alpha1 API. The full + documentation for this API can be found at: https://cloud.google.com/web3 + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. + diff --git a/gcloud/alpha/blockchain-node-engine/nodes/help b/gcloud/alpha/blockchain-node-engine/nodes/help index 06a34b13a..813ce5094 100644 --- a/gcloud/alpha/blockchain-node-engine/nodes/help +++ b/gcloud/alpha/blockchain-node-engine/nodes/help @@ -1,11 +1,12 @@ NAME - gcloud alpha blockchain-node-engine nodes - list blockchain nodes + gcloud alpha blockchain-node-engine nodes - commands for viewing and + manipulating blockchain nodes SYNOPSIS gcloud alpha blockchain-node-engine nodes COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List blockchain nodes. + (ALPHA) Commands for viewing and manipulating blockchain nodes. GCLOUD WIDE FLAGS These flags are available to all commands: --help. diff --git a/gcloud/alpha/builds/connections/add-iam-policy-binding b/gcloud/alpha/builds/connections/add-iam-policy-binding new file mode 100644 index 000000000..6c6cf352d --- /dev/null +++ b/gcloud/alpha/builds/connections/add-iam-policy-binding @@ -0,0 +1,130 @@ +NAME + gcloud alpha builds connections add-iam-policy-binding - add IAM policy + binding to a Cloud Build connection + +SYNOPSIS + gcloud alpha builds connections add-iam-policy-binding + (CONNECTION : --region=REGION) --member=PRINCIPAL --role=ROLE + [--condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add IAM policy binding to a Cloud Build connection. One binding + consists of a member and a role. + +EXAMPLES + To add an IAM policy binding for the role of + 'roles/cloudbuild.connectionViewer' for the user 'test-user@gmail.com' on a + Connection named 'my-conn', run: + + $ gcloud alpha builds connections add-iam-policy-binding my-conn \ + --region=us-central1 --member='user:test-user@gmail.com' \ + --role='roles/cloudbuild.connectionViewer' + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build Connection for which to add the IAM + policy binding. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) 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 + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +OPTIONAL FLAGS + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the 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. This variant is also available: + + $ gcloud beta builds connections add-iam-policy-binding + diff --git a/gcloud/alpha/builds/connections/create/github b/gcloud/alpha/builds/connections/create/github new file mode 100644 index 000000000..e7f1d132c --- /dev/null +++ b/gcloud/alpha/builds/connections/create/github @@ -0,0 +1,114 @@ +NAME + gcloud alpha builds connections create github - create a Cloud Build + Connection of type GitHub + +SYNOPSIS + gcloud alpha builds connections create github + (CONNECTION : --region=REGION) [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + : --app-installation-id=APP_INSTALLATION_ID] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud Build Connection of type GitHub (for github.com). + + Connections for github.com can be created either by following an + installation process (that requires manual steps in a web browser) or by + providing the properties of an already-installed application (installation + ID and a user token) as arguments to this command. + +EXAMPLES + To create a connection by following the installation process, provide only + the connection name: + + $ gcloud alpha builds connections create github myconn \ + --project=myproj --region=us-central1 + + The command will print a URL to be opened in a web browser in order to + authorize Cloud Build (i.e. Cloud Build gets an OAuth token for the github + account that you use). After doing this authorization, you can get the + connection's installation state with the describe command: + + $ gcloud alpha builds connections describe myconn + + The output will include a second link to install the Cloud Build GitHub + App. After doing this, the connection will be in installation state + COMPLETE and repositories can be added to it (see gcloud alpha builds + repositories create). + + -- + + To create a complete connection (e.g. based on an existing user token and + installation), provide both the authorizer secret token and the app + installation id: + + $ gcloud alpha builds connections create github myconn \ + --project=myproj --region=us-central1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + mytoken/versions/1 --app-installation-id=1234 + + Above command creates the connection in installation state COMPLETE, ready + for adding repositories. + +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. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Group of arguments for configuring a complete connnection. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the authorizer user's token. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --app-installation-id=APP_INSTALLATION_ID + Installation ID of the Cloud Build GitHub App. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud beta builds connections create github + diff --git a/gcloud/alpha/builds/connections/create/github-enterprise b/gcloud/alpha/builds/connections/create/github-enterprise new file mode 100644 index 000000000..559f787ab --- /dev/null +++ b/gcloud/alpha/builds/connections/create/github-enterprise @@ -0,0 +1,168 @@ +NAME + gcloud alpha builds connections create github-enterprise - create a Cloud + Build Connection of type GitHub Enterprise + +SYNOPSIS + gcloud alpha builds connections create github-enterprise + (CONNECTION : --region=REGION) --host-uri=HOST_URI [--async] + [--app-id=APP_ID --app-slug=APP_SLUG + --private-key-secret-version=PRIVATE_KEY_SECRET_VERSION + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + : --app-installation-id=APP_INSTALLATION_ID] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE + : --ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud Build Connection of type GitHub Enterprise. + + Connections for GitHub Enterprise can be created either by following an + intallation process (that requires manual steps in a web browser) or by + providing all the properties of an already-installed application as + arguments to this command. + + If the GitHub Enterprise server can only be accessed within a VPC, a + Service Directory service resource can be provided for connecting to it. + +EXAMPLES + To create a connection by following the installation process, provide only + the connection name and the host URI. If the server can only be accessed + within a VPC, provide also the Service Directory service resource: + + $ gcloud alpha builds connections create github-enterprise \ + my-ghe-conn --project=myproj --region=us-central1 \ + --host-uri=https://my.ghe-server.net \ + --service-directory-service=projects/myproj/namespaces/x/\ + services/mysds + + The command will print a URL to be opened in a web browser in order create + and install a GitHub App in that server. After following the URL, you can + get the connection's installation state with The describe command: + + $ gcloud alpha builds connections describe my-ghe-conn \ + --region=us-central1 + + If the connection's installation state is not COMPLETE yet, it will provide + a link to continue the installation process. Once the connection is in + installation state COMPLETE, repositories can be added to it (see gcloud + alpha builds repositories create). + + -- + + To create a complete connection (e.g. based on an existing installation), + provide all the parameters: + + $ gcloud alpha builds connections create github-enterprise \ + my-ghe-conn --project=myproj --region=us-central1 --app-id=111 \ + --app-slug=gcb-app \ + --service-directory-service=projects/myproj/namespaces/x/\ + services/mysds \ + --private-key-secret-version=projects/myproj/secrets/pk/\ + versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 --app-slug=myapp --app-installation-id=1234 + + Above command creates the connection in installation state COMPLETE, ready + for adding repositories. + +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 + --host-uri=HOST_URI + URI of the GitHub Enterprise server. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Group of arguments for the GitHub App properties. + + --app-id=APP_ID + App ID of the GitHub App in the GitHub Enterprise server. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --app-slug=APP_SLUG + App slug (url-friendly name) of the GitHub App. When seeing the + configuration page of the App (e.g. in + https://my-ghe-server.net/settings/apps/my-app), the app-slug is the + last component of the URL path ("my-app" in that example). + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --private-key-secret-version=PRIVATE_KEY_SECRET_VERSION + Secret containing the private key of the GitHub App. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events generated by the GitHub App. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --app-installation-id=APP_INSTALLATION_ID + Installation ID of the Cloud Build GitHub App. + + Group of arguments for configuring access through Service Directory. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the GitHub + Enterprise Server. 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. This variant is also available: + + $ gcloud beta builds connections create github-enterprise + diff --git a/gcloud/alpha/builds/connections/create/help b/gcloud/alpha/builds/connections/create/help new file mode 100644 index 000000000..362ad5352 --- /dev/null +++ b/gcloud/alpha/builds/connections/create/help @@ -0,0 +1,32 @@ +NAME + gcloud alpha builds connections create - create Connections in Google Cloud + Build + +SYNOPSIS + gcloud alpha builds connections create COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create Connections in Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + github + (ALPHA) Create a Cloud Build Connection of type GitHub. + + github-enterprise + (ALPHA) Create a Cloud Build Connection of type GitHub Enterprise. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 builds connections create + diff --git a/gcloud/alpha/builds/connections/delete b/gcloud/alpha/builds/connections/delete new file mode 100644 index 000000000..28e32b872 --- /dev/null +++ b/gcloud/alpha/builds/connections/delete @@ -0,0 +1,68 @@ +NAME + gcloud alpha builds connections delete - delete a Cloud Build Connection + +SYNOPSIS + gcloud alpha builds connections delete (CONNECTION : --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud Build Connection. + +EXAMPLES + To delete Cloud Build connection my-conn in region us-central1, run the + following command: + + $ gcloud alpha builds connections delete my-conn --region=us-central1 + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build connection to delete. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud beta builds connections delete + diff --git a/gcloud/alpha/builds/connections/describe b/gcloud/alpha/builds/connections/describe new file mode 100644 index 000000000..6f18444f8 --- /dev/null +++ b/gcloud/alpha/builds/connections/describe @@ -0,0 +1,65 @@ +NAME + gcloud alpha builds connections describe - describe a Cloud Build + Connection + +SYNOPSIS + gcloud alpha builds connections describe (CONNECTION : --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Cloud Build Connection. + +EXAMPLES + To describe a Connection my-conn in region us-central1, run the following + command: + + $ gcloud alpha builds connections describe my-conn \ + --region=us-central1 + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build Connection to describe. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud beta builds connections describe + diff --git a/gcloud/alpha/builds/connections/get-iam-policy b/gcloud/alpha/builds/connections/get-iam-policy new file mode 100644 index 000000000..5dc4dde54 --- /dev/null +++ b/gcloud/alpha/builds/connections/get-iam-policy @@ -0,0 +1,92 @@ +NAME + gcloud alpha builds connections get-iam-policy - get the IAM policy for a + Cloud Build connection + +SYNOPSIS + gcloud alpha builds connections get-iam-policy + (CONNECTION : --region=REGION) [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get the IAM policy for a Cloud Build connection. + +EXAMPLES + To print the IAM policy for a Connection named 'my-conn', run the following + command: + + $ gcloud alpha builds connections get-iam-policy my-conn \ + --region=us-central1 + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build Connection from which to get IAM policy. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument 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. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the 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. This variant is also available: + + $ gcloud beta builds connections get-iam-policy + diff --git a/gcloud/alpha/builds/connections/help b/gcloud/alpha/builds/connections/help new file mode 100644 index 000000000..1a27ebc7e --- /dev/null +++ b/gcloud/alpha/builds/connections/help @@ -0,0 +1,52 @@ +NAME + gcloud alpha builds connections - manage connections for Google Cloud Build + +SYNOPSIS + gcloud alpha builds connections GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage connections for Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + create + (ALPHA) Create Connections in Google Cloud Build. + + update + (ALPHA) Update Connections in Google Cloud Build. + +COMMANDS + COMMAND is one of the following: + + add-iam-policy-binding + (ALPHA) Add IAM policy binding to a Cloud Build connection. + + delete + (ALPHA) Delete a Cloud Build Connection. + + describe + (ALPHA) Describe a Cloud Build Connection. + + get-iam-policy + (ALPHA) Get the IAM policy for a Cloud Build connection. + + list + (ALPHA) List all Cloud Build connections for a project and region. + + set-iam-policy + (ALPHA) Set the IAM policy for a Cloud Build connection. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 builds connections + diff --git a/gcloud/database-migration/private-connections/list b/gcloud/alpha/builds/connections/list similarity index 69% rename from gcloud/database-migration/private-connections/list rename to gcloud/alpha/builds/connections/list index f550b9610..9a4671b5f 100644 --- a/gcloud/database-migration/private-connections/list +++ b/gcloud/alpha/builds/connections/list @@ -1,38 +1,37 @@ NAME - gcloud database-migration private-connections list - list private - connections + gcloud alpha builds connections list - list all Cloud Build connections for + a project and region SYNOPSIS - gcloud database-migration private-connections list --region=REGION + gcloud alpha builds connections list [--region=REGION] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List private connections. + (ALPHA) List all Cloud Build connections for a project and region. EXAMPLES - To list all private connections in a project and location 'us-central1', - run: + To list all the Cloud Build connections in region us-central1, run the + following command: - $ gcloud database-migration private-connections list \ - --region=us-central1 + $ gcloud alpha builds connections list --region=us-central1 -REQUIRED FLAGS - Region resource - The region you want to list the private connections for. +FLAGS + Region resource - Cloud Build location to list all contained connections. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the project attribute: ◆ provide the argument --region on the command line with a fully specified name; + ◆ set the property builds/region with a fully specified name; ◆ provide the argument --project on the command line; ◆ set the property core/project. - This must be specified. - --region=REGION ID of the region or fully qualified identifier for the region. To set the region attribute: - ▸ provide the argument --region on the command line. + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. LIST COMMAND FLAGS --filter=EXPRESSION @@ -75,5 +74,14 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. API REFERENCE - This command uses the datamigration/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/database-migration/ + 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. This variant is also available: + + $ gcloud beta builds connections list + diff --git a/gcloud/alpha/builds/connections/set-iam-policy b/gcloud/alpha/builds/connections/set-iam-policy new file mode 100644 index 000000000..49ac0da7d --- /dev/null +++ b/gcloud/alpha/builds/connections/set-iam-policy @@ -0,0 +1,76 @@ +NAME + gcloud alpha builds connections set-iam-policy - set the IAM policy for a + Cloud Build connection + +SYNOPSIS + gcloud alpha builds connections set-iam-policy + (CONNECTION : --region=REGION) POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Set the IAM policy for a Cloud Build connection as defined in a + JSON or YAML file. + + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + 'policy.json' and set it for the Connection named 'my-conn': + + $ gcloud alpha builds connections set-iam-policy my-conn \ + policy.json --region=us-central1 + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build Connection for which to set IAM policy. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument 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. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the 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. This variant is also available: + + $ gcloud beta builds connections set-iam-policy + diff --git a/gcloud/alpha/builds/connections/update/github b/gcloud/alpha/builds/connections/update/github new file mode 100644 index 000000000..51d441fe1 --- /dev/null +++ b/gcloud/alpha/builds/connections/update/github @@ -0,0 +1,87 @@ +NAME + gcloud alpha builds connections update github - update a Cloud Build + Connection of type GitHub + +SYNOPSIS + gcloud alpha builds connections update github + (CONNECTION : --region=REGION) + [--app-installation-id=APP_INSTALLATION_ID] [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud Build Connection of type GitHub (for github.com). + +EXAMPLES + To update the authorizer token, provide the connection name and the + authorizer token secret: + + $ gcloud alpha builds connections update github myconn \ + --region=us-central1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + mytoken/versions/1 + + To update the installation id, provide the connection name and the + installation id of the Cloud Build GitHub app. + + $ gcloud alpha builds connections update github myconn \ + --region=us-central1 --app-installation-id=1234 + +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 + --app-installation-id=APP_INSTALLATION_ID + Installation ID of the Cloud Build GitHub App. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the authorizer user's token. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud beta builds connections update github + diff --git a/gcloud/alpha/builds/connections/update/github-enterprise b/gcloud/alpha/builds/connections/update/github-enterprise new file mode 100644 index 000000000..1d9986cb2 --- /dev/null +++ b/gcloud/alpha/builds/connections/update/github-enterprise @@ -0,0 +1,112 @@ +NAME + gcloud alpha builds connections update github-enterprise - update a Cloud + Build Connection of type GitHub Enterprise + +SYNOPSIS + gcloud alpha builds connections update github-enterprise + (CONNECTION : --region=REGION) [--app-id=APP_ID] + [--app-installation-id=APP_INSTALLATION_ID] [--app-slug=APP_SLUG] + [--async] [--host-uri=HOST_URI] + [--private-key-secret-version=PRIVATE_KEY_SECRET_VERSION] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE] + [--ssl-ca-file=SSL_CA_FILE] + [--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud Build Connection of type GitHub Enterprise. + +EXAMPLES + To update the ssl_ca, provide the connection name and the ssl_ca file: + + $ gcloud alpha builds connections update github-enterprise \ + my-ghe-conn --region=us-west1 --ssl-ca-file=mycertificate.crt + + To update the installation id, provide the connection name and the + installation id of the Cloud Build GitHub app. + + $ gcloud alpha builds connections update github-enterprise \ + my-ghe-conn --region=us-west1 --app-installation-id=1234 + +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 + --app-id=APP_ID + App ID of the GitHub App in the GitHub Enterprise server. + + --app-installation-id=APP_INSTALLATION_ID + Installation ID of the Cloud Build GitHub App. + + --app-slug=APP_SLUG + App slug (url-friendly name) of the GitHub App. When seeing the + configuration page of the App (e.g. in + https://my-ghe-server.net/settings/apps/my-app), the app-slug is the + last component of the URL path ("my-app" in that example). + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --host-uri=HOST_URI + URI of the GitHub Enterprise server. + + --private-key-secret-version=PRIVATE_KEY_SECRET_VERSION + Secret containing the private key of the GitHub App. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the GitHub + Enterprise Server. 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. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events generated by the GitHub App. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud beta builds connections update github-enterprise + diff --git a/gcloud/alpha/builds/connections/update/help b/gcloud/alpha/builds/connections/update/help new file mode 100644 index 000000000..6595f5b63 --- /dev/null +++ b/gcloud/alpha/builds/connections/update/help @@ -0,0 +1,32 @@ +NAME + gcloud alpha builds connections update - update Connections in Google Cloud + Build + +SYNOPSIS + gcloud alpha builds connections update COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update Connections in Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + github + (ALPHA) Update a Cloud Build Connection of type GitHub. + + github-enterprise + (ALPHA) Update a Cloud Build Connection of type GitHub Enterprise. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 builds connections update + diff --git a/gcloud/alpha/builds/help b/gcloud/alpha/builds/help index 69bc2ce05..5093b28c1 100644 --- a/gcloud/alpha/builds/help +++ b/gcloud/alpha/builds/help @@ -15,12 +15,18 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + connections + (ALPHA) Manage connections for Google Cloud Build. + deploy (ALPHA) Build and deploy images with Google Cloud Build. enterprise-config (ALPHA) Manage Enterprise configurations for Google Cloud Build. + repositories + (ALPHA) Manage repositories for Google Cloud Build. + triggers (ALPHA) Create and manage build triggers for Google Cloud Build. diff --git a/gcloud/alpha/builds/repositories/create b/gcloud/alpha/builds/repositories/create new file mode 100644 index 000000000..d5e41d323 --- /dev/null +++ b/gcloud/alpha/builds/repositories/create @@ -0,0 +1,81 @@ +NAME + gcloud alpha builds repositories create - create a Cloud Build repository + +SYNOPSIS + gcloud alpha builds repositories create + (REPOSITORY : --connection=CONNECTION --region=REGION) + --remote-uri=REMOTE_URI [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud Build repository in a connection. + +EXAMPLES + To Create a repository with name my-repo in the connection my-conn, run the + following command: + + $ gcloud alpha builds repositories create my-repo \ + --remote-uri=https://github.com/octocat/Hello-World.git \ + --connection=my-conn --region=us-central1 + +POSITIONAL ARGUMENTS + Repository resource - Repository 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 repository 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. + + REPOSITORY + ID of the repository or fully qualified identifier for the + repository. To set the repository attribute: + ▸ provide the argument repository on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --connection=CONNECTION + Connection ID. To set the connection attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --connection on the command line. + + --region=REGION + The Google Cloud region. To set the region attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + --remote-uri=REMOTE_URI + The remote git clone URL of the repository. + +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. This variant is also available: + + $ gcloud beta builds repositories create + diff --git a/gcloud/alpha/builds/repositories/delete b/gcloud/alpha/builds/repositories/delete new file mode 100644 index 000000000..d43cc8123 --- /dev/null +++ b/gcloud/alpha/builds/repositories/delete @@ -0,0 +1,76 @@ +NAME + gcloud alpha builds repositories delete - delete a Cloud Build Repository + +SYNOPSIS + gcloud alpha builds repositories delete + (REPOSITORY : --connection=CONNECTION --region=REGION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud Build Repository in a Connection. + +EXAMPLES + To delete Cloud Build repository my-repo in connection my-conn, run the + following command: + + $ gcloud alpha builds repositories delete my-repo \ + --connection=my-conn --region=us-central1 + +POSITIONAL ARGUMENTS + Repository resource - Cloud Build repository to delete. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument repository 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. + + REPOSITORY + ID of the repository or fully qualified identifier for the + repository. To set the repository attribute: + ▸ provide the argument repository on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --connection=CONNECTION + Connection ID. To set the connection attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --connection on the command line. + + --region=REGION + The Google Cloud region. To set the region attribute: + ▸ provide the argument repository 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud beta builds repositories delete + diff --git a/gcloud/alpha/builds/repositories/describe b/gcloud/alpha/builds/repositories/describe new file mode 100644 index 000000000..2c467a7c4 --- /dev/null +++ b/gcloud/alpha/builds/repositories/describe @@ -0,0 +1,71 @@ +NAME + gcloud alpha builds repositories describe - describe a Cloud Build + Repository + +SYNOPSIS + gcloud alpha builds repositories describe + (REPOSITORY : --connection=CONNECTION --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Cloud Build Repository. + +EXAMPLES + To list all the Cloud Build connections in region us-central1, run the + following command: + + $ gcloud alpha builds repositories describe --region=us-central1 + +POSITIONAL ARGUMENTS + Repository resource - Cloud Build Repository to describe. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument repository 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. + + REPOSITORY + ID of the repository or fully qualified identifier for the + repository. To set the repository attribute: + ▸ provide the argument repository on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --connection=CONNECTION + Connection ID. To set the connection attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --connection on the command line. + + --region=REGION + The Google Cloud region. To set the region attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +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. This variant is also available: + + $ gcloud beta builds repositories describe + diff --git a/gcloud/alpha/builds/repositories/help b/gcloud/alpha/builds/repositories/help new file mode 100644 index 000000000..9ceaa59c5 --- /dev/null +++ b/gcloud/alpha/builds/repositories/help @@ -0,0 +1,38 @@ +NAME + gcloud alpha builds repositories - manage repositories for Google Cloud + Build + +SYNOPSIS + gcloud alpha builds repositories COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage repositories for Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a Cloud Build repository. + + delete + (ALPHA) Delete a Cloud Build Repository. + + describe + (ALPHA) Describe a Cloud Build Repository. + + list + (ALPHA) List all Cloud Build repositories in a connection. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 builds repositories + diff --git a/gcloud/alpha/builds/repositories/list b/gcloud/alpha/builds/repositories/list new file mode 100644 index 000000000..ca2649914 --- /dev/null +++ b/gcloud/alpha/builds/repositories/list @@ -0,0 +1,100 @@ +NAME + gcloud alpha builds repositories list - list all Cloud Build repositories + in a connection + +SYNOPSIS + gcloud alpha builds repositories list + (--connection=CONNECTION : --region=REGION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all Cloud Build repositories in a connection. + +EXAMPLES + To list all the repositories in the Cloud Build connection my-conn, run the + following command: + + $ gcloud alpha builds repositories list --connection=my-conn \ + --region=us-central1 + +REQUIRED FLAGS + Connection resource - Cloud Build connection to list all contained + repositories. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) 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=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 flag 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. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the 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. This variant is also available: + + $ gcloud beta builds repositories list + diff --git a/gcloud/alpha/builds/worker-pools/create b/gcloud/alpha/builds/worker-pools/create index 71baf3980..169f5001b 100644 --- a/gcloud/alpha/builds/worker-pools/create +++ b/gcloud/alpha/builds/worker-pools/create @@ -84,15 +84,15 @@ OPTIONAL FLAGS --peered-network-ip-range=PEERED_NETWORK_IP_RANGE An IP range for your peered network. Specify the IP range using Classless Inter-Domain Routing (CIDR) notation with a slash and - the subnet prefix size, such as '/29'. + the subnet prefix size, such as /29. Your subnet prefix size must be between 1 and 29. Optional: you can specify an IP address before the subnet prefix value - for - example 192.168.0.1/24. + example 192.168.0.0/24. If no IP address is specified, your VPC automatically determines the starting IP for the range. If no IP range is specified, Cloud - Build uses '/24' as the default network IP range. + Build uses /24 as the default network IP range. --no-public-egress If set, workers in the worker pool are created without an diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index 713c44105..f2214c2fe 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -100,7 +100,8 @@ OPTIONAL FLAGS for memory-optimized VMs. TYPE must be one of: accelerator-optimized, compute-optimized, compute-optimized-c2d, general-purpose, general-purpose-e2, general-purpose-n2, general-purpose-n2d, - general-purpose-t2d, memory-optimized, memory-optimized-m3. + general-purpose-t2d, graphics-optimized, memory-optimized, + memory-optimized-m3. Manage the reservations to be created with the commitment. diff --git a/gcloud/alpha/compute/firewall-policies/rules/create b/gcloud/alpha/compute/firewall-policies/rules/create index 428bfdc03..abe0acbda 100644 --- a/gcloud/alpha/compute/firewall-policies/rules/create +++ b/gcloud/alpha/compute/firewall-policies/rules/create @@ -66,7 +66,9 @@ OPTIONAL FLAGS --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] Destination Threat Intelligence lists to match for this rule. Can only - be specified if DIRECTION is egress. + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --direction=DIRECTION Direction of the traffic the rule is applied. The default is to apply @@ -106,7 +108,9 @@ OPTIONAL FLAGS --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] Source Threat Intelligence lists to match for this rule. Can only be - specified if DIRECTION is ingress. + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --target-resources=[TARGET_RESOURCES,...] List of URLs of target resources to which the rule is applied. diff --git a/gcloud/alpha/compute/firewall-policies/rules/update b/gcloud/alpha/compute/firewall-policies/rules/update index 74212ea16..3289c3eb7 100644 --- a/gcloud/alpha/compute/firewall-policies/rules/update +++ b/gcloud/alpha/compute/firewall-policies/rules/update @@ -68,7 +68,9 @@ OPTIONAL FLAGS --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] Destination Threat Intelligence lists to match for this rule. Can only - be specified if DIRECTION is egress. + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --direction=DIRECTION Direction of the traffic the rule is applied. The default is to apply @@ -111,7 +113,9 @@ OPTIONAL FLAGS --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] Source Threat Intelligence lists to match for this rule. Can only be - specified if DIRECTION is ingress. + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --target-resources=[TARGET_RESOURCES,...] List of URLs of target resources to which the rule is applied. diff --git a/gcloud/alpha/compute/future-reservations/create b/gcloud/alpha/compute/future-reservations/create index 19de977d0..61fbf40bf 100644 --- a/gcloud/alpha/compute/future-reservations/create +++ b/gcloud/alpha/compute/future-reservations/create @@ -22,14 +22,27 @@ DESCRIPTION (ALPHA) Create a Compute Engine future reservation. EXAMPLES - To create a Compute Engine future reservation, run: + To create a Compute Engine future reservation by specifying VM properties + using an instance template, run: $ gcloud alpha compute future-reservations create \ my-future-reservation --total-count=1000 \ - --machine-type=n1-standard-1 \ - --min-cpu-platform="Intel Haswell" --project=project-01 \ + --start-time=2022-11-10 --end-time=2022-12-10 \ + --name-prefix=prefix-reservation \ + --source-instance-template=example-instance-template \ --zone=fake-zone + To create a Compute Engine future reservation by directly specifying VM + properties, run: + + $ gcloud alpha compute future-reservations create \ + my-future-reservation --total-count=1000 \ + --start-time=2022-11-10 --end-time=2022-12-10 \ + --name-prefix=prefix-reservation --machine-type=custom-8-10240 \ + --min-cpu-platform="Intel Haswell" \ + --accelerator=count=2,type=nvidia-tesla-v100 \ + --local-ssd=size=375,interface=scsi + POSITIONAL ARGUMENTS FUTURE_RESERVATION Name of the future reservation to create. diff --git a/gcloud/alpha/compute/instance-groups/managed/create b/gcloud/alpha/compute/instance-groups/managed/create index 3469c2546..c684ec879 100644 --- a/gcloud/alpha/compute/instance-groups/managed/create +++ b/gcloud/alpha/compute/instance-groups/managed/create @@ -17,7 +17,13 @@ SYNOPSIS [--zones=ZONE,[ZONE,...]] [--health-check=HEALTH_CHECK | --http-health-check=HTTP_HEALTH_CHECK | --https-health-check=HTTPS_HEALTH_CHECK] - [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--region=REGION | --zone=ZONE] + [--update-policy-max-surge=MAX_SURGE + --update-policy-max-unavailable=MAX_UNAVAILABLE + --update-policy-min-ready=MIN_READY + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD --update-policy-type=UPDATE_TYPE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute instance-groups managed create creates a @@ -278,6 +284,97 @@ OPTIONAL FLAGS Overrides the default compute/zone property value for this command invocation. + Parameters for setting update policy for this managed instance group. + + --update-policy-max-surge=MAX_SURGE + Maximum additional number of VMs that can be created during the + update process. This can be a fixed number (e.g. 5) or a percentage + of size to the managed instance group (e.g. 10%). Defaults to 0 if + the managed instance group has stateful configuration, or to the + number of zones in which it operates otherwise. + + --update-policy-max-unavailable=MAX_UNAVAILABLE + Maximum number of VMs that can be unavailable during the update + process. This can be a fixed number (e.g. 5) or a percentage of size + to the managed instance group (e.g. 10%). Defaults to the number of + zones in which the managed instance group operates. + + --update-policy-min-ready=MIN_READY + Minimum time for which a newly created VM should be ready to be + considered available. For example 10s for 10 seconds. See $ gcloud + topic datetimes for information on duration formats. + + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + Use this flag to minimize disruption as much as possible or to apply + a more disruptive action than is strictly necessary. The MIG performs + at least this action on each VM while updating. If the update + requires a more disruptive action than the one specified here, then + the more disruptive action is performed. UPDATE_POLICY_MINIMAL_ACTION + must be one of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION + Use this flag to prevent an update if it requires more disruption + than you can afford. At most, the MIG performs the specified action + on each VM while updating. If the update requires a more disruptive + action than the one specified here, then the update fails and no + changes are made. UPDATE_POLICY_MOST_DISRUPTIVE_ACTION must be one + of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD + Type of replacement method. Specifies what action will be taken to + update VMs. Defaults to ``recreate`` if the managed instance group + has stateful configuration, or to ``substitute`` otherwise. + UPDATE_POLICY_REPLACEMENT_METHOD must be one of: + + recreate + Recreate VMs and preserve the VM names. The VM IDs and creation + timestamps might change. + substitute + Delete old VMs and create VMs with new names. + + --update-policy-type=UPDATE_TYPE + Specifies the type of update process. You can specify either + ``proactive`` so that the managed instance group proactively executes + actions in order to bring VMs to their target versions or + ``opportunistic`` so that no action is proactively executed but the + update will be performed as part of other actions. UPDATE_TYPE must + be one of: + + opportunistic + Do not proactively replace VMs. Create new VMs and delete old + ones on resizes of the group and when you target specific VMs to + be updated or recreated. + proactive + Replace VMs proactively. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/compute/instance-groups/managed/instance-configs/create b/gcloud/alpha/compute/instance-groups/managed/instance-configs/create index 0706846d0..6e055194b 100644 --- a/gcloud/alpha/compute/instance-groups/managed/instance-configs/create +++ b/gcloud/alpha/compute/instance-groups/managed/instance-configs/create @@ -73,15 +73,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME],[mode=MODE],[source=SOURCE] Disks considered stateful by the instance group. Managed instance diff --git a/gcloud/alpha/compute/instance-groups/managed/instance-configs/delete b/gcloud/alpha/compute/instance-groups/managed/instance-configs/delete index 247c38442..73930f872 100644 --- a/gcloud/alpha/compute/instance-groups/managed/instance-configs/delete +++ b/gcloud/alpha/compute/instance-groups/managed/instance-configs/delete @@ -45,15 +45,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --update-instance Apply the configuration changes immediately to the instance. If you diff --git a/gcloud/alpha/compute/instance-groups/managed/instance-configs/update b/gcloud/alpha/compute/instance-groups/managed/instance-configs/update index 3bd970735..01dc511e2 100644 --- a/gcloud/alpha/compute/instance-groups/managed/instance-configs/update +++ b/gcloud/alpha/compute/instance-groups/managed/instance-configs/update @@ -80,15 +80,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --remove-stateful-disks=DEVICE_NAME,[DEVICE_NAME,...] Remove stateful configuration for the specified disks from the diff --git a/gcloud/alpha/compute/instance-groups/managed/rolling-action/replace b/gcloud/alpha/compute/instance-groups/managed/rolling-action/replace index da5913514..eaf2cea0f 100644 --- a/gcloud/alpha/compute/instance-groups/managed/rolling-action/replace +++ b/gcloud/alpha/compute/instance-groups/managed/rolling-action/replace @@ -38,8 +38,8 @@ FLAGS --replacement-method=REPLACEMENT_METHOD Type of replacement method. Specifies what action will be taken to - update instances. Defaults to recreate if the managed instance group - has stateful configuration, or to substitute otherwise. + update instances. Defaults to ``recreate`` if the managed instance + group has stateful configuration, or to ``substitute`` otherwise. REPLACEMENT_METHOD must be one of: recreate diff --git a/gcloud/alpha/compute/instance-groups/managed/rolling-action/start-update b/gcloud/alpha/compute/instance-groups/managed/rolling-action/start-update index d9d2c3fac..9263968e5 100644 --- a/gcloud/alpha/compute/instance-groups/managed/rolling-action/start-update +++ b/gcloud/alpha/compute/instance-groups/managed/rolling-action/start-update @@ -38,8 +38,9 @@ COMMONLY USED FLAGS Desired update type. TYPE must be one of: opportunistic - Do not proactively replace instances. Create new instances and - delete old on resizes of the group. + Do not proactively replace VMs. Create new VMs and delete old ones + on resizes of the group and when you target specific VMs to be + updated or recreated. proactive Replace instances proactively. @@ -78,15 +79,15 @@ OTHER FLAGS MINIMAL_ACTION must be one of: refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --most-disruptive-allowed-action=MOST_DISRUPTIVE_ALLOWED_ACTION Use this flag to prevent an update if it requires more disruption than @@ -100,20 +101,20 @@ OTHER FLAGS MOST_DISRUPTIVE_ALLOWED_ACTION must be one of: refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --replacement-method=REPLACEMENT_METHOD Type of replacement method. Specifies what action will be taken to - update instances. Defaults to recreate if the managed instance group - has stateful configuration, or to substitute otherwise. + update instances. Defaults to ``recreate`` if the managed instance + group has stateful configuration, or to ``substitute`` otherwise. REPLACEMENT_METHOD must be one of: recreate diff --git a/gcloud/alpha/compute/instance-groups/managed/update b/gcloud/alpha/compute/instance-groups/managed/update index 0447a8864..478f48cd4 100644 --- a/gcloud/alpha/compute/instance-groups/managed/update +++ b/gcloud/alpha/compute/instance-groups/managed/update @@ -20,14 +20,27 @@ SYNOPSIS | --initial-delay=INITIAL_DELAY --health-check=HEALTH_CHECK | --http-health-check=HTTP_HEALTH_CHECK | --https-health-check=HTTPS_HEALTH_CHECK] - [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--region=REGION | --zone=ZONE] + [--update-policy-max-surge=MAX_SURGE + --update-policy-max-unavailable=MAX_UNAVAILABLE + --update-policy-min-ready=MIN_READY + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD --update-policy-type=UPDATE_TYPE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update a Compute Engine managed instance group. gcloud alpha compute instance-groups managed update allows you to specify - or modify the stateful policy and autohealing policy for an existing - managed instance group. + or modify the description and group policies for an existing managed + instance group, including the group's update policy and optional + autohealing and stateful policies + + The group's update policy defines how an updated VM configuration is + applied to existing VMs in the group. For more information, see [Applying + new configurations] + (https://cloud.google.com/compute/docs/instance-groups/updating-migs) to + VMs in a MIG. A stateful policy defines which resources should be preserved across the group. When instances in the group are recreated, stateful resources are @@ -290,6 +303,97 @@ FLAGS Overrides the default compute/zone property value for this command invocation. + Parameters for setting update policy for this managed instance group. + + --update-policy-max-surge=MAX_SURGE + Maximum additional number of VMs that can be created during the + update process. This can be a fixed number (e.g. 5) or a percentage + of size to the managed instance group (e.g. 10%). Defaults to 0 if + the managed instance group has stateful configuration, or to the + number of zones in which it operates otherwise. + + --update-policy-max-unavailable=MAX_UNAVAILABLE + Maximum number of VMs that can be unavailable during the update + process. This can be a fixed number (e.g. 5) or a percentage of size + to the managed instance group (e.g. 10%). Defaults to the number of + zones in which the managed instance group operates. + + --update-policy-min-ready=MIN_READY + Minimum time for which a newly created VM should be ready to be + considered available. For example 10s for 10 seconds. See $ gcloud + topic datetimes for information on duration formats. + + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + Use this flag to minimize disruption as much as possible or to apply + a more disruptive action than is strictly necessary. The MIG performs + at least this action on each VM while updating. If the update + requires a more disruptive action than the one specified here, then + the more disruptive action is performed. UPDATE_POLICY_MINIMAL_ACTION + must be one of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION + Use this flag to prevent an update if it requires more disruption + than you can afford. At most, the MIG performs the specified action + on each VM while updating. If the update requires a more disruptive + action than the one specified here, then the update fails and no + changes are made. UPDATE_POLICY_MOST_DISRUPTIVE_ACTION must be one + of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD + Type of replacement method. Specifies what action will be taken to + update VMs. Defaults to ``recreate`` if the managed instance group + has stateful configuration, or to ``substitute`` otherwise. + UPDATE_POLICY_REPLACEMENT_METHOD must be one of: + + recreate + Recreate VMs and preserve the VM names. The VM IDs and creation + timestamps might change. + substitute + Delete old VMs and create VMs with new names. + + --update-policy-type=UPDATE_TYPE + Specifies the type of update process. You can specify either + ``proactive`` so that the managed instance group proactively executes + actions in order to bring VMs to their target versions or + ``opportunistic`` so that no action is proactively executed but the + update will be performed as part of other actions. UPDATE_TYPE must + be one of: + + opportunistic + Do not proactively replace VMs. Create new VMs and delete old + ones on resizes of the group and when you target specific VMs to + be updated or recreated. + proactive + Replace VMs proactively. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/compute/instance-groups/managed/update-instances b/gcloud/alpha/compute/instance-groups/managed/update-instances index fbef8bc5c..6f1e5590d 100644 --- a/gcloud/alpha/compute/instance-groups/managed/update-instances +++ b/gcloud/alpha/compute/instance-groups/managed/update-instances @@ -66,15 +66,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --most-disruptive-allowed-action=MOST_DISRUPTIVE_ALLOWED_ACTION; default="replace" Use this flag to prevent an update if it requires more disruption than @@ -90,15 +90,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. At most one of these can be specified: diff --git a/gcloud/alpha/compute/interconnects/attachments/dedicated/create b/gcloud/alpha/compute/interconnects/attachments/dedicated/create index 1e120c4d5..0ab47cd31 100644 --- a/gcloud/alpha/compute/interconnects/attachments/dedicated/create +++ b/gcloud/alpha/compute/interconnects/attachments/dedicated/create @@ -154,7 +154,7 @@ OPTIONAL FLAGS SUBNET_LENGTH must be one of: 29, 30. --vlan=VLAN - Desired VLAN for this attachment, in the range 2-4094. If not supplied, + Desired VLAN for this attachment, in the range 2-4093. If not supplied, Google will automatically select a VLAN. GCLOUD WIDE FLAGS diff --git a/gcloud/alpha/compute/network-endpoint-groups/list-network-endpoints b/gcloud/alpha/compute/network-endpoint-groups/list-network-endpoints index de9a117b2..a0620e3dc 100644 --- a/gcloud/alpha/compute/network-endpoint-groups/list-network-endpoints +++ b/gcloud/alpha/compute/network-endpoint-groups/list-network-endpoints @@ -4,8 +4,9 @@ NAME SYNOPSIS gcloud alpha compute network-endpoint-groups list-network-endpoints NAME - [--global | --zone=ZONE] [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + [--global | --region=REGION | --zone=ZONE] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) List network endpoints in a network endpoint group. @@ -27,6 +28,26 @@ FLAGS --global If set, the network endpoint group is global. + --region=REGION + Region of the network endpoint group to operate on. If not specified, + you might be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + --zone=ZONE Zone of the network endpoint group to operate on. If not specified and the compute/zone property isn't set, you might be prompted to diff --git a/gcloud/alpha/compute/network-firewall-policies/rules/create b/gcloud/alpha/compute/network-firewall-policies/rules/create index fa5c49c1d..9eb592cac 100644 --- a/gcloud/alpha/compute/network-firewall-policies/rules/create +++ b/gcloud/alpha/compute/network-firewall-policies/rules/create @@ -75,7 +75,9 @@ OPTIONAL FLAGS --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] Destination Threat Intelligence lists to match for this rule. Can only - be specified if DIRECTION is egress. + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --direction=DIRECTION Direction of the traffic the rule is applied. The default is to apply @@ -130,7 +132,9 @@ OPTIONAL FLAGS --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] Source Threat Intelligence lists to match for this rule. Can only be - specified if DIRECTION is ingress. + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --target-secure-tags=[TARGET_SECURE_TAGS,...] An optional, list of target secure tags with a name of the format diff --git a/gcloud/alpha/compute/network-firewall-policies/rules/update b/gcloud/alpha/compute/network-firewall-policies/rules/update index 44eae3de3..bf7630f58 100644 --- a/gcloud/alpha/compute/network-firewall-policies/rules/update +++ b/gcloud/alpha/compute/network-firewall-policies/rules/update @@ -68,7 +68,9 @@ OPTIONAL FLAGS --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] Destination Threat Intelligence lists to match for this rule. Can only - be specified if DIRECTION is egress. + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --direction=DIRECTION Direction of the traffic the rule is applied. The default is to apply @@ -126,7 +128,9 @@ OPTIONAL FLAGS --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] Source Threat Intelligence lists to match for this rule. Can only be - specified if DIRECTION is ingress. + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --target-secure-tags=[TARGET_SECURE_TAGS,...] An optional, list of target secure tags with a name of the format diff --git a/gcloud/alpha/compute/reservations/create b/gcloud/alpha/compute/reservations/create index fc7d3b890..c91653cb8 100644 --- a/gcloud/alpha/compute/reservations/create +++ b/gcloud/alpha/compute/reservations/create @@ -21,11 +21,22 @@ DESCRIPTION (ALPHA) Create a Compute Engine reservation. EXAMPLES - To create a Compute Engine reservation, run: + To create a Compute Engine reservation by specifying VM properties using an + instance template, run: $ gcloud alpha compute reservations create my-reservation \ - --zone=fake-zone --vm-count=1 --machine-type=n1-standard-1 \ - --min-cpu-platform="Intel Haswell" + --vm-count=1 \ + --source-instance-template=example-instance-template \ + --zone=fake-zone + + To create a Compute Engine reservation by directly specifying VM + properties, run: + + $ gcloud alpha compute reservations create my-reservation \ + --vm-count=1 --machine-type=custom-8-10240 \ + --min-cpu-platform="Intel Haswell" \ + --accelerator=count=2,type=nvidia-tesla-v100 \ + --local-ssd=size=375,interface=scsi --zone=fake-zone POSITIONAL ARGUMENTS RESERVATION diff --git a/gcloud/alpha/compute/security-policies/rules/create b/gcloud/alpha/compute/security-policies/rules/create index ed25a7783..2c6b4db3b 100644 --- a/gcloud/alpha/compute/security-policies/rules/create +++ b/gcloud/alpha/compute/security-policies/rules/create @@ -11,6 +11,9 @@ SYNOPSIS [--ban-threshold-interval-sec=BAN_THRESHOLD_INTERVAL_SEC] [--conform-action=CONFORM_ACTION] [--description=DESCRIPTION] [--enforce-on-key=ENFORCE_ON_KEY] + [--enforce-on-key-configs=[[all],[ip],[xff-ip], + [http-cookie=HTTP_COOKIE], + [http-header=HTTP_HEADER],[http-path],[sni],[region-code]],[...]] [--enforce-on-key-name=ENFORCE_ON_KEY_NAME] [--exceed-action=EXCEED_ACTION] [--exceed-action-rpc-status-code=EXCEED_ACTION_RPC_STATUS_CODE] @@ -137,6 +140,29 @@ OPTIONAL FLAGS ENFORCE_ON_KEY must be one of: ip, all, http-header, xff-ip, http-cookie, http-path, sni, region-code. + --enforce-on-key-configs=[[all],[ip],[xff-ip],[http-cookie=HTTP_COOKIE],[http-header=HTTP_HEADER],[http-path],[sni],[region-code]],[...] + Specify up to 3 key type/name pairs to rate limit. Valid key types are: + + ◆ ip: each client IP address has this limit enforced separately + ◆ all: a single limit is applied to all requests matching this rule + ◆ http-header: key type takes the value of the HTTP header configured + in enforce-on-key-name as the key value + ◆ xff-ip: takes the original IP address specified in the + X-Forwarded-For header as the key + ◆ http-cookie: key type takes the value of the HTTP cookie configured + in enforce-on-key-name as the key value + ◆ http-path: key type takes the value of the URL path in the request + ◆ sni: key type takes the value of the server name indication from + the TLS session of the HTTPS request + ◆ region-code: key type takes the value of the region code from which + the request originates + + Key names are only applicable to the following key types: + ◆ http-header: The name of the HTTP header whose value is taken as + the key value. + ◆ http-cookie: The name of the HTTP cookie whose value is taken as + the key value. + --enforce-on-key-name=ENFORCE_ON_KEY_NAME Determines the key name for the rate limit key. Applicable only for the following rate limit key types: diff --git a/gcloud/alpha/compute/security-policies/rules/update b/gcloud/alpha/compute/security-policies/rules/update index 7d9b58d13..a76d04800 100644 --- a/gcloud/alpha/compute/security-policies/rules/update +++ b/gcloud/alpha/compute/security-policies/rules/update @@ -9,6 +9,9 @@ SYNOPSIS [--ban-threshold-interval-sec=BAN_THRESHOLD_INTERVAL_SEC] [--conform-action=CONFORM_ACTION] [--description=DESCRIPTION] [--enforce-on-key=ENFORCE_ON_KEY] + [--enforce-on-key-configs=[[all],[ip],[xff-ip], + [http-cookie=HTTP_COOKIE], + [http-header=HTTP_HEADER],[http-path],[sni],[region-code]],[...]] [--enforce-on-key-name=ENFORCE_ON_KEY_NAME] [--exceed-action=EXCEED_ACTION] [--exceed-action-rpc-status-code=EXCEED_ACTION_RPC_STATUS_CODE] @@ -125,6 +128,29 @@ FLAGS ENFORCE_ON_KEY must be one of: ip, all, http-header, xff-ip, http-cookie, http-path, sni, region-code. + --enforce-on-key-configs=[[all],[ip],[xff-ip],[http-cookie=HTTP_COOKIE],[http-header=HTTP_HEADER],[http-path],[sni],[region-code]],[...] + Specify up to 3 key type/name pairs to rate limit. Valid key types are: + + ◆ ip: each client IP address has this limit enforced separately + ◆ all: a single limit is applied to all requests matching this rule + ◆ http-header: key type takes the value of the HTTP header configured + in enforce-on-key-name as the key value + ◆ xff-ip: takes the original IP address specified in the + X-Forwarded-For header as the key + ◆ http-cookie: key type takes the value of the HTTP cookie configured + in enforce-on-key-name as the key value + ◆ http-path: key type takes the value of the URL path in the request + ◆ sni: key type takes the value of the server name indication from + the TLS session of the HTTPS request + ◆ region-code: key type takes the value of the region code from which + the request originates + + Key names are only applicable to the following key types: + ◆ http-header: The name of the HTTP header whose value is taken as + the key value. + ◆ http-cookie: The name of the HTTP cookie whose value is taken as + the key value. + --enforce-on-key-name=ENFORCE_ON_KEY_NAME Determines the key name for the rate limit key. Applicable only for the following rate limit key types: diff --git a/gcloud/alpha/container/clusters/upgrade b/gcloud/alpha/container/clusters/upgrade index d40b1fe86..5eabb6894 100644 --- a/gcloud/alpha/container/clusters/upgrade +++ b/gcloud/alpha/container/clusters/upgrade @@ -13,35 +13,37 @@ SYNOPSIS DESCRIPTION (ALPHA) Upgrades the Kubernetes version of an existing container cluster. - This command upgrades the Kubernetes version of the nodes or master of a - cluster. Note that the Kubernetes version of the cluster's master is also + This command upgrades the Kubernetes version of the node pools or master of + a cluster. Note that the Kubernetes version of the cluster's master is also periodically upgraded automatically as new releases are available. - If desired cluster version is omitted, node upgrades default to the current - master version and master upgrades default to the default cluster version, - which can be found in the server config. + If desired cluster version is omitted, node pool upgrades default to the + current master version and master upgrades default to the default cluster + version, which can be found in the server config. - By running this command, all of the cluster's nodes will be deleted and - recreated one at a time. While persistent Kubernetes resources, such as - pods backed by replication controllers, will be rescheduled onto new nodes, - a small cluster may experience a few minutes where there are insufficient - nodes available to run all of the scheduled Kubernetes resources. + During node pool upgrades, nodes will be deleted and recreated. While + persistent Kubernetes resources, such as Pods backed by replication + controllers, will be rescheduled onto new nodes, a small cluster may + experience a few minutes where there are insufficient nodes available to + run all of the scheduled Kubernetes resources. Please ensure that any data you wish to keep is stored on a persistent disk before upgrading the cluster. Ephemeral Kubernetes resources--in - particular, pods without replication controllers--will be lost, while + particular, Pods without replication controllers--will be lost, while persistent Kubernetes resources will get rescheduled. EXAMPLES - Upgrade the nodes of sample-cluster to the Kubernetes version of the - cluster's master. - - $ gcloud alpha container clusters upgrade sample-cluster - - Upgrade the nodes of sample-cluster to Kubernetes version 1.14.7-gke.14: + Upgrade the node pool pool-1 of sample-cluster to the Kubernetes version of + the cluster's master. $ gcloud alpha container clusters upgrade sample-cluster \ - --cluster-version="1.14.7-gke.14" + --node-pool=pool-1 + + Upgrade the node pool pool-1 of sample-cluster to Kubernetes version + 1.14.7-gke.14: + + $ gcloud alpha container clusters upgrade sample-cluster \ + --node-pool=pool-1 --cluster-version="1.14.7-gke.14" Upgrade the master of sample-cluster to the default cluster version: @@ -57,10 +59,11 @@ FLAGS complete. --cluster-version=CLUSTER_VERSION - The Kubernetes release version to which to upgrade the cluster's nodes. + The GKE release version to which to upgrade the cluster's node pools or + master. - If desired cluster version is omitted, node upgrades default to the - current master version and master upgrades default to the default + If desired cluster version is omitted, node pool upgrades default to + the current master version and master upgrades default to the default cluster version, which can be found in the server config. You can find the list of allowed versions for upgrades by running: @@ -83,8 +86,7 @@ FLAGS $ gcloud container get-server-config --master - Upgrade the cluster's master to the latest version of Kubernetes - supported on Kubernetes Engine. Nodes cannot be upgraded at the same + Upgrade the cluster's master. Node pools cannot be upgraded at the same time as the master. --node-pool=NODE_POOL diff --git a/gcloud/alpha/dataproc/clusters/create b/gcloud/alpha/dataproc/clusters/create index 69d4f57d7..0dbcc8fe4 100644 --- a/gcloud/alpha/dataproc/clusters/create +++ b/gcloud/alpha/dataproc/clusters/create @@ -5,7 +5,14 @@ SYNOPSIS gcloud alpha dataproc clusters create (CLUSTER : --region=REGION) --autoscaling-policy=AUTOSCALING_POLICY [--no-address] [--async] [--bucket=BUCKET] [--dataproc-metastore=DATAPROC_METASTORE] - [--enable-component-gateway] + [--driver-pool-accelerator=[type=TYPE,[count=COUNT],...]] + [--driver-pool-boot-disk-size=DRIVER_POOL_BOOT_DISK_SIZE] + [--driver-pool-boot-disk-type=DRIVER_POOL_BOOT_DISK_TYPE] + [--driver-pool-id=DRIVER_POOL_ID] + [--driver-pool-local-ssd-interface=DRIVER_POOL_LOCAL_SSD_INTERFACE] + [--driver-pool-machine-type=DRIVER_POOL_MACHINE_TYPE] + [--driver-pool-min-cpu-platform=PLATFORM] + [--driver-pool-size=DRIVER_POOL_SIZE] [--enable-component-gateway] [--initialization-action-timeout=TIMEOUT; default="10m"] [--initialization-actions=CLOUD_STORAGE_URI,[...]] [--labels=[KEY=VALUE,...]] @@ -16,6 +23,7 @@ SYNOPSIS [--master-machine-type=MASTER_MACHINE_TYPE] [--master-min-cpu-platform=PLATFORM] [--max-idle=MAX_IDLE] [--node-group=NODE_GROUP] + [--num-driver-pool-local-ssds=NUM_DRIVER_POOL_LOCAL_SSDS] [--num-master-local-ssds=NUM_MASTER_LOCAL_SSDS] [--num-masters=NUM_MASTERS] [--num-secondary-worker-local-ssds=NUM_SECONDARY_WORKER_LOCAL_SSDS] @@ -124,6 +132,55 @@ FLAGS external metastore in the format: "projects/{project-id}/locations/{region}/services/{service-name}". + --driver-pool-accelerator=[type=TYPE,[count=COUNT],...] + Attaches accelerators, such as GPUs, to the driver-pool instance(s). + + type + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. + + count + The number of accelerators to attach to each instance. The default + value is 1. + + --driver-pool-boot-disk-size=DRIVER_POOL_BOOT_DISK_SIZE + The size of the boot disk. The value must be a whole number followed by + a size unit of KB for kilobyte, MB for megabyte, GB for gigabyte, or TB + for terabyte. For example, 10GB will produce a 10 gigabyte disk. The + minimum size a boot disk can have is 10 GB. Disk size must be a + multiple of 1 GB. + + --driver-pool-boot-disk-type=DRIVER_POOL_BOOT_DISK_TYPE + The type of the boot disk. The value must be pd-balanced, pd-ssd, or + pd-standard. + + --driver-pool-id=DRIVER_POOL_ID + Custom identifier for the DRIVER Node Group being created. If not + provided, a random string is generated. + + --driver-pool-local-ssd-interface=DRIVER_POOL_LOCAL_SSD_INTERFACE + Interface to use to attach local SSDs to cluster driver pool node(s). + + --driver-pool-machine-type=DRIVER_POOL_MACHINE_TYPE + The type of machine to use for the cluster driver pool nodes. Defaults + to server-specified. + + --driver-pool-min-cpu-platform=PLATFORM + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: + + $ gcloud compute zones describe ZONE + + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). + + --driver-pool-size=DRIVER_POOL_SIZE + The size of the cluster driver pool. + --enable-component-gateway Enable access to the web UIs of selected components on the cluster through the component gateway. @@ -145,17 +202,16 @@ FLAGS numbers. --master-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the master instance(s). + Attaches accelerators, such as GPUs, to the master instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --master-boot-disk-size=MASTER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -176,18 +232,16 @@ FLAGS server-specified. --master-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --max-idle=MAX_IDLE The duration before cluster is auto-deleted after last job completes, @@ -199,6 +253,9 @@ FLAGS a short name ("node-group-name") or in the format "projects/{project-id}/zones/{zone}/nodeGroups/{node-group-name}". + --num-driver-pool-local-ssds=NUM_DRIVER_POOL_LOCAL_SSDS + The number of local SSDs to attach to each cluster driver pool node. + --num-master-local-ssds=NUM_MASTER_LOCAL_SSDS The number of local SSDs to attach to the master in a cluster. @@ -264,17 +321,17 @@ FLAGS for more information. --secondary-worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the secondary-worker instance(s). + Attaches accelerators, such as GPUs, to the secondary-worker + instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --secondary-worker-boot-disk-size=SECONDARY_WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -312,17 +369,16 @@ FLAGS cluster and jobs data, such as Spark and MapReduce history files. --worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the worker instance(s). + Attaches accelerators, such as GPUs, to the worker instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --worker-boot-disk-size=WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -342,18 +398,16 @@ FLAGS The type of machine to use for workers. Defaults to server-specified. --worker-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --zone=ZONE, -z ZONE The compute zone (e.g. us-central1-a) for the cluster. If empty and diff --git a/gcloud/alpha/dataproc/help b/gcloud/alpha/dataproc/help index dc31fc88e..156bc538c 100644 --- a/gcloud/alpha/dataproc/help +++ b/gcloud/alpha/dataproc/help @@ -43,6 +43,9 @@ GROUPS jobs (ALPHA) Submit and manage Dataproc jobs. + node-groups + (ALPHA) Manage Dataproc node groups. + operations (ALPHA) View and manage Dataproc operations. diff --git a/gcloud/alpha/dataproc/node-groups/describe b/gcloud/alpha/dataproc/node-groups/describe new file mode 100644 index 000000000..e0af91a58 --- /dev/null +++ b/gcloud/alpha/dataproc/node-groups/describe @@ -0,0 +1,71 @@ +NAME + gcloud alpha dataproc node-groups describe - describe the node group + +SYNOPSIS + gcloud alpha dataproc node-groups describe + (NODE_GROUP : --cluster=CLUSTER --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe the node group. + +EXAMPLES + To describe a node group, run: + + $ gcloud alpha dataproc node-groups describe my-node-group-id \ + --region=us-central1 --cluster=my-cluster-name + +POSITIONAL ARGUMENTS + Node group resource - ID of the node group to describe. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument node_group on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + NODE_GROUP + ID of the node_group or fully qualified identifier for the + node_group. To set the node_group attribute: + ▸ provide the argument node_group on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The Cluster name. To set the cluster attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + Dataproc region for the node_group. Each Dataproc region constitutes + an independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud dataproc node-groups describe + + $ gcloud beta dataproc node-groups describe + diff --git a/gcloud/alpha/dataproc/node-groups/help b/gcloud/alpha/dataproc/node-groups/help new file mode 100644 index 000000000..201a493c6 --- /dev/null +++ b/gcloud/alpha/dataproc/node-groups/help @@ -0,0 +1,45 @@ +NAME + gcloud alpha dataproc node-groups - manage Dataproc node groups + +SYNOPSIS + gcloud alpha dataproc node-groups COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage and modify Dataproc node groups created with a parent + cluster. + +EXAMPLES + To describe a node group: + + $ gcloud alpha dataproc node-groups describe NODE_GROUP_ID \ + --cluster cluster_name --region region + + To resize a node group: + + $ gcloud alpha dataproc node-groups resize NODE_GROUP_ID \ + --cluster cluster_name --region region --size new_size + +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 the node group. + + resize + (ALPHA) Resize the number of nodes in the node group. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud dataproc node-groups + + $ gcloud beta dataproc node-groups + diff --git a/gcloud/alpha/dataproc/node-groups/resize b/gcloud/alpha/dataproc/node-groups/resize new file mode 100644 index 000000000..33091217d --- /dev/null +++ b/gcloud/alpha/dataproc/node-groups/resize @@ -0,0 +1,82 @@ +NAME + gcloud alpha dataproc node-groups resize - resize the number of nodes in + the node group + +SYNOPSIS + gcloud alpha dataproc node-groups resize + (NODE_GROUP : --cluster=CLUSTER --region=REGION) --size=SIZE + [--graceful-decommission-timeout=GRACEFUL_DECOMMISSION_TIMEOUT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Resize the number of nodes in the node group. + +EXAMPLES + To resize a node group, run: + + $ gcloud alpha dataproc node-groups resize my-node-group-id \ + --region=us-central1 --cluster=my-cluster-name --size=5 + +POSITIONAL ARGUMENTS + Node group resource - ID of the node group to resize. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument node_group on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + NODE_GROUP + ID of the node_group or fully qualified identifier for the + node_group. To set the node_group attribute: + ▸ provide the argument node_group on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The Cluster name. To set the cluster attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + Dataproc region for the node_group. Each Dataproc region constitutes + an independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +REQUIRED FLAGS + --size=SIZE + New size for a node group. + +OPTIONAL FLAGS + --graceful-decommission-timeout=GRACEFUL_DECOMMISSION_TIMEOUT + Graceful decommission timeout for a node group scale-down resize. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud dataproc node-groups resize + + $ gcloud beta dataproc node-groups resize + diff --git a/gcloud/alpha/dataproc/workflow-templates/set-managed-cluster b/gcloud/alpha/dataproc/workflow-templates/set-managed-cluster index c4926040b..f80917280 100644 --- a/gcloud/alpha/dataproc/workflow-templates/set-managed-cluster +++ b/gcloud/alpha/dataproc/workflow-templates/set-managed-cluster @@ -141,17 +141,16 @@ FLAGS numbers. --master-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the master instance(s). + Attaches accelerators, such as GPUs, to the master instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --master-boot-disk-size=MASTER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -172,18 +171,16 @@ FLAGS server-specified. --master-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --node-group=NODE_GROUP The name of the sole-tenant node group to create the cluster on. Can be @@ -255,17 +252,17 @@ FLAGS for more information. --secondary-worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the secondary-worker instance(s). + Attaches accelerators, such as GPUs, to the secondary-worker + instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --secondary-worker-boot-disk-size=SECONDARY_WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -303,17 +300,16 @@ FLAGS cluster and jobs data, such as Spark and MapReduce history files. --worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the worker instance(s). + Attaches accelerators, such as GPUs, to the worker instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --worker-boot-disk-size=WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -333,18 +329,16 @@ FLAGS The type of machine to use for workers. Defaults to server-specified. --worker-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --zone=ZONE, -z ZONE The compute zone (e.g. us-central1-a) for the cluster. If empty and diff --git a/gcloud/alpha/edge-cloud/container/vpn-connections/create b/gcloud/alpha/edge-cloud/container/vpn-connections/create index 88313344a..c62110e0c 100644 --- a/gcloud/alpha/edge-cloud/container/vpn-connections/create +++ b/gcloud/alpha/edge-cloud/container/vpn-connections/create @@ -7,8 +7,7 @@ SYNOPSIS (VPN_CONNECTION : --location=LOCATION) --cluster=CLUSTER --vpc-network=VPC_NETWORK [--async] [--high-availability] [--labels=[KEY=VALUE,...]] [--nat-gateway-ip=NAT_GATEWAY_IP] - [--vpc-project=VPC_PROJECT] [--vpc-service-account=VPC_SERVICE_ACCOUNT] - [GCLOUD_WIDE_FLAG ...] + [--vpc-project=VPC_PROJECT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Creates a new VPN connection. @@ -58,7 +57,7 @@ REQUIRED FLAGS --vpc-network=VPC_NETWORK The name of the VPC network to be connected. By default it is assumed to be under the same project as cluster. If this VPC network is under a - different project, vpc-project and vpc-service-account are required. + different project, vpc-project is required. OPTIONAL FLAGS --async @@ -86,11 +85,6 @@ OPTIONAL FLAGS The project of the VPC network. Required if the project of VPC network differs from the project of the cluster. - --vpc-service-account=VPC_SERVICE_ACCOUNT - The service account in the VPC project used to create Cloud Router and - Cloud HA VPNs when creating/deleting the VPN connection. Required if - the project of VPC network differs from the project of the cluster. - GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/export b/gcloud/alpha/firestore/export index a8b83d5ec..45754c69d 100644 --- a/gcloud/alpha/firestore/export +++ b/gcloud/alpha/firestore/export @@ -46,11 +46,10 @@ FLAGS complete. --collection-ids=[COLLECTION_IDS,...] - A list specifying which collections will be included in the operation. + List specifying which collections will be included in the operation. When omitted, all collections are included. - For example, to operate on only the 'customers' and 'orders' - collections: + For example, to operate on only the customers and orders collections: $ gcloud alpha firestore export --collection-ids='customers','orders' @@ -62,13 +61,12 @@ FLAGS $ gcloud alpha firestore export --database='foo' --namespace-ids=[NAMESPACE_IDS,...] - A list specifying which namespaces will be included in the operation. + List specifying which namespaces will be included in the operation. When omitted, all namespaces are included. This is only supported for Datastore Mode databases. - For example, to operate on only the 'customers' and 'orders' - namespaces: + For example, to operate on only the customers and orders namespaces: $ gcloud alpha firestore export --namespaces-ids='customers','orders' diff --git a/gcloud/alpha/firestore/import b/gcloud/alpha/firestore/import index 8aa5b69dc..0613f5407 100644 --- a/gcloud/alpha/firestore/import +++ b/gcloud/alpha/firestore/import @@ -41,11 +41,10 @@ FLAGS complete. --collection-ids=[COLLECTION_IDS,...] - A list specifying which collections will be included in the operation. + List specifying which collections will be included in the operation. When omitted, all collections are included. - For example, to operate on only the 'customers' and 'orders' - collections: + For example, to operate on only the customers and orders collections: $ gcloud alpha firestore import --collection-ids='customers','orders' @@ -57,13 +56,12 @@ FLAGS $ gcloud alpha firestore import --database='foo' --namespace-ids=[NAMESPACE_IDS,...] - A list specifying which namespaces will be included in the operation. + List specifying which namespaces will be included in the operation. When omitted, all namespaces are included. This is only supported for Datastore Mode databases. - For example, to operate on only the 'customers' and 'orders' - namespaces: + For example, to operate on only the customers and orders namespaces: $ gcloud alpha firestore import --namespaces-ids='customers','orders' diff --git a/gcloud/alpha/firestore/operations/cancel b/gcloud/alpha/firestore/operations/cancel index b3e411d8f..721ea31b5 100644 --- a/gcloud/alpha/firestore/operations/cancel +++ b/gcloud/alpha/firestore/operations/cancel @@ -3,7 +3,8 @@ NAME Firestore admin operation SYNOPSIS - gcloud alpha firestore operations cancel NAME [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore operations cancel NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Cancel a currently-running Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud alpha firestore operations cancel --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/operations/delete b/gcloud/alpha/firestore/operations/delete index 6bfcb041e..fd9566af2 100644 --- a/gcloud/alpha/firestore/operations/delete +++ b/gcloud/alpha/firestore/operations/delete @@ -3,7 +3,8 @@ NAME Firestore admin operation SYNOPSIS - gcloud alpha firestore operations delete NAME [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore operations delete NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete a completed Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud alpha firestore operations delete --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/operations/describe b/gcloud/alpha/firestore/operations/describe index ff47a302c..85e9e814e 100644 --- a/gcloud/alpha/firestore/operations/describe +++ b/gcloud/alpha/firestore/operations/describe @@ -3,7 +3,8 @@ NAME Cloud Firestore admin operation SYNOPSIS - gcloud alpha firestore operations describe NAME [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore operations describe NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Retrieves information about a Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud alpha firestore operations describe --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/operations/list b/gcloud/alpha/firestore/operations/list index c97cf1fa6..470b179c2 100644 --- a/gcloud/alpha/firestore/operations/list +++ b/gcloud/alpha/firestore/operations/list @@ -3,7 +3,8 @@ NAME operations and their status SYNOPSIS - gcloud alpha firestore operations list [--filter=EXPRESSION] + gcloud alpha firestore operations list + [--database=DATABASE; default="(default)"] [--filter=EXPRESSION] [--limit=LIMIT; default=100] [--page-size=PAGE_SIZE; default=100] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -24,6 +25,14 @@ EXAMPLES $ gcloud alpha firestore operations list --filter="done:true" +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud alpha firestore operations list --database='foo' + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/alpha/netapp/active-directories/create b/gcloud/alpha/netapp/active-directories/create index 96fdb20ed..24fd43fa9 100644 --- a/gcloud/alpha/netapp/active-directories/create +++ b/gcloud/alpha/netapp/active-directories/create @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud alpha netapp active-directories create (ACTIVE_DIRECTORY : --location=LOCATION) --dns=DNS --domain=DOMAIN - --net-bios=NET_BIOS --password=PASSWORD --username=USERNAME [--async] + --net-bios-prefix=NET_BIOS_PREFIX --password=PASSWORD + --username=USERNAME [--async] [--backup-operators=[BACKUP_OPERATOR,...]] [--description=DESCRIPTION] [--enable-aes=ENABLE_AES] [--enable-ldap-signing=ENABLE_LDAP_SIGNING] [--encrypt-dc-connections=ENCRYPT_DC_CONNECTIONS] @@ -54,8 +55,8 @@ REQUIRED FLAGS --domain=DOMAIN The Active Directory domain. - --net-bios=NET_BIOS - NetBIOS name of the server. + --net-bios-prefix=NET_BIOS_PREFIX + NetBIOS prefix name of the server. --password=PASSWORD Password of the Active Directory domain administrator. diff --git a/gcloud/alpha/netapp/active-directories/update b/gcloud/alpha/netapp/active-directories/update index c73e77465..3356647c1 100644 --- a/gcloud/alpha/netapp/active-directories/update +++ b/gcloud/alpha/netapp/active-directories/update @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud alpha netapp active-directories update (ACTIVE_DIRECTORY : --location=LOCATION) --dns=DNS --domain=DOMAIN - --net-bios=NET_BIOS --password=PASSWORD --username=USERNAME [--async] + --net-bios-prefix=NET_BIOS_PREFIX --password=PASSWORD + --username=USERNAME [--async] [--backup-operators=[BACKUP_OPERATOR,...]] [--description=DESCRIPTION] [--enable-aes=ENABLE_AES] [--enable-ldap-signing=ENABLE_LDAP_SIGNING] [--encrypt-dc-connections=ENCRYPT_DC_CONNECTIONS] @@ -55,8 +56,8 @@ REQUIRED FLAGS --domain=DOMAIN The Active Directory domain. - --net-bios=NET_BIOS - NetBIOS name of the server. + --net-bios-prefix=NET_BIOS_PREFIX + NetBIOS prefix name of the server. --password=PASSWORD Password of the Active Directory domain administrator. diff --git a/gcloud/alpha/netapp/volumes/create b/gcloud/alpha/netapp/volumes/create index 33cff9ae5..c94812556 100644 --- a/gcloud/alpha/netapp/volumes/create +++ b/gcloud/alpha/netapp/volumes/create @@ -180,11 +180,11 @@ OPTIONAL FLAGS --smb-settings=SMB_SETTING,[SMB_SETTING,...] List of settings specific to SMB protocolfor a Cloud NetApp Files VolumeValid component values are: ENCRYPT_DATA, BROWSABLE, - CHANGE_NOTIFY, 'NON_BROWSABLE', 'OPLOCKS', 'SHOW_SNAPSHOT', - 'SHOW_PREVIOUS_VERSIONS', 'ACCESS_BASED_ENUMERATION', - 'CONTINUOUSLY_AVAILABLE' + CHANGE_NOTIFY, NON_BROWSABLE, OPLOCKS, SHOW_SNAPSHOT, + SHOW_PREVIOUS_VERSIONS, ACCESS_BASED_ENUMERATION, + CONTINUOUSLY_AVAILABLE - For more information, look athttps://cloud.google.com/netapp/docs/reference/rest/v1alpha1/projects.locations.volumes#smbsettings. + For more information, look at https://cloud.google.com/netapp/docs/reference/rest/v1alpha1/projects.locations.volumes#smbsettings. --snap-reserve=SNAP_RESERVE The percentage of volume storage reserved for snapshot storage. The diff --git a/gcloud/alpha/netapp/volumes/update b/gcloud/alpha/netapp/volumes/update index a145293ab..8792f8a6e 100644 --- a/gcloud/alpha/netapp/volumes/update +++ b/gcloud/alpha/netapp/volumes/update @@ -170,11 +170,11 @@ FLAGS --smb-settings=SMB_SETTING,[SMB_SETTING,...] List of settings specific to SMB protocolfor a Cloud NetApp Files VolumeValid component values are: ENCRYPT_DATA, BROWSABLE, - CHANGE_NOTIFY, 'NON_BROWSABLE', 'OPLOCKS', 'SHOW_SNAPSHOT', - 'SHOW_PREVIOUS_VERSIONS', 'ACCESS_BASED_ENUMERATION', - 'CONTINUOUSLY_AVAILABLE' + CHANGE_NOTIFY, NON_BROWSABLE, OPLOCKS, SHOW_SNAPSHOT, + SHOW_PREVIOUS_VERSIONS, ACCESS_BASED_ENUMERATION, + CONTINUOUSLY_AVAILABLE - For more information, look athttps://cloud.google.com/netapp/docs/reference/rest/v1alpha1/projects.locations.volumes#smbsettings. + For more information, look at https://cloud.google.com/netapp/docs/reference/rest/v1alpha1/projects.locations.volumes#smbsettings. --snap-reserve=SNAP_RESERVE The percentage of volume storage reserved for snapshot storage. The diff --git a/gcloud/alpha/pubsub/schemas/commit b/gcloud/alpha/pubsub/schemas/commit new file mode 100644 index 000000000..757449ae2 --- /dev/null +++ b/gcloud/alpha/pubsub/schemas/commit @@ -0,0 +1,73 @@ +NAME + gcloud alpha pubsub schemas commit - commit a Pub/Sub schema revision + +SYNOPSIS + gcloud alpha pubsub schemas commit SCHEMA --type=TYPE + (--definition=DEFINITION | --definition-file=DEFINITION_FILE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Commit a Pub/Sub schema revision. + +EXAMPLES + To commit a PROTOCOL_BUFFER schema revision called "key-schema" that + requires exactly one-string field named "key", run: + + $ gcloud alpha pubsub schemas commit key-schema \ + --definition="syntax = 'proto3'; message Message { optional \ + string key = 1; }" --type=protocol-buffer To commit an equivalent \ + AVRO schema revision, run: + + $ gcloud alpha pubsub schemas commit key-schema \ + --definition="{ 'type': 'record', 'namespace': 'my.ns', 'name': \ + 'KeyMsg', 'fields': [ { 'name': 'key', 'type': 'string' } ] }" \ + --type=avro + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema to revise. 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +REQUIRED FLAGS + --type=TYPE + The type of the schema. + + Schema definition + + Exactly one of these must be specified: + + --definition=DEFINITION + The new definition of the schema. + + --definition-file=DEFINITION_FILE + File containing the new schema definition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-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 pubsub schemas commit + + $ gcloud beta pubsub schemas commit + diff --git a/gcloud/alpha/pubsub/schemas/delete-revision b/gcloud/alpha/pubsub/schemas/delete-revision new file mode 100644 index 000000000..60e9ae289 --- /dev/null +++ b/gcloud/alpha/pubsub/schemas/delete-revision @@ -0,0 +1,50 @@ +NAME + gcloud alpha pubsub schemas delete-revision - delete a Pub/Sub schema + revision + +SYNOPSIS + gcloud alpha pubsub schemas delete-revision SCHEMA [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Pub/Sub schema revision. + +EXAMPLES + To roll back to an existing schema revision called "key-schema" with + revision_id: "0a0b0c0d", run: + + $ gcloud alpha pubsub schemas delete-revision key-schema@0a0b0c0d + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema revision to delete. This represents a + Cloud resource. (NOTE) Some attributes are not given arguments in this + group but can be set in other ways. To set the project attribute: + ◆ provide the argument schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema 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. These variants are also available: + + $ gcloud pubsub schemas delete-revision + + $ gcloud beta pubsub schemas delete-revision + diff --git a/gcloud/alpha/pubsub/schemas/help b/gcloud/alpha/pubsub/schemas/help index 4db7d4b27..4d5e190d0 100644 --- a/gcloud/alpha/pubsub/schemas/help +++ b/gcloud/alpha/pubsub/schemas/help @@ -18,18 +18,30 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + commit + (ALPHA) Commit a Pub/Sub schema revision. + create (ALPHA) Create a Pub/Sub schema. delete (ALPHA) Delete a Pub/Sub schema. + delete-revision + (ALPHA) Delete a Pub/Sub schema revision. + describe (ALPHA) Show details of a Pub/Sub schema. list (ALPHA) List Pub/Sub schemas. + list-revisions + (ALPHA) List revisions of a Pub/Sub schema. + + rollback + (ALPHA) Roll back a Pub/Sub schema to a specified revision. + validate-message (ALPHA) Validate a message against a Pub/Sub schema. diff --git a/gcloud/alpha/pubsub/schemas/list-revisions b/gcloud/alpha/pubsub/schemas/list-revisions new file mode 100644 index 000000000..f4312b1c8 --- /dev/null +++ b/gcloud/alpha/pubsub/schemas/list-revisions @@ -0,0 +1,100 @@ +NAME + gcloud alpha pubsub schemas list-revisions - list revisions of a Pub/Sub + schema + +SYNOPSIS + gcloud alpha pubsub schemas list-revisions SCHEMA + [--view=VIEW; default="basic"] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List revisions of a Pub/Sub schema. + +EXAMPLES + To list the revisions for a schema, run: + + $ gcloud alpha pubsub schemas list-revisions my-schema + +POSITIONAL ARGUMENTS + Schema resource - Parent Pub/Sub schema to list all contained revisions. + 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +FLAGS + --view=VIEW; default="basic" + There are two possible views, 'basic' and 'full', default is 'basic'. + VIEW must be one of: + + basic + Include the name and type of the schema, but not the definition. + + full + Include all Schema object fields. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the pubsub/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/pubsub/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 pubsub schemas list-revisions + + $ gcloud beta pubsub schemas list-revisions + diff --git a/gcloud/alpha/pubsub/schemas/rollback b/gcloud/alpha/pubsub/schemas/rollback new file mode 100644 index 000000000..5fc2f77a4 --- /dev/null +++ b/gcloud/alpha/pubsub/schemas/rollback @@ -0,0 +1,56 @@ +NAME + gcloud alpha pubsub schemas rollback - roll back a Pub/Sub schema to a + specified revision + +SYNOPSIS + gcloud alpha pubsub schemas rollback SCHEMA --revision-id=REVISION_ID + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Roll back a Pub/Sub schema to a specified revision. + +EXAMPLES + To roll back to an existing schema revision called "key-schema" with + revision_id: "0a0b0c0d", run: + + $ gcloud alpha pubsub schemas rollback key-schema \ + --revision-id=0a0b0c0d + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema to rollback. 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +REQUIRED FLAGS + --revision-id=REVISION_ID + The revision to roll back to. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud pubsub schemas rollback + + $ gcloud beta pubsub schemas rollback + diff --git a/gcloud/alpha/pubsub/topics/create b/gcloud/alpha/pubsub/topics/create index 42ed12b4d..34cd8a3e3 100644 --- a/gcloud/alpha/pubsub/topics/create +++ b/gcloud/alpha/pubsub/topics/create @@ -8,7 +8,9 @@ SYNOPSIS [--message-retention-duration=MESSAGE_RETENTION_DURATION] [--message-storage-policy-allowed-regions=[REGION,...]] [--message-encoding=ENCODING (--schema=SCHEMA - : --schema-project=SCHEMA_PROJECT)] + : --schema-project=SCHEMA_PROJECT) + : --first-revision-id=FIRST_REVISION_ID + --last-revision-id=LAST_REVISION_ID] [--topic-encryption-key=TOPIC_ENCRYPTION_KEY : --topic-encryption-key-keyring=TOPIC_ENCRYPTION_KEY_KEYRING --topic-encryption-key-location=TOPIC_ENCRYPTION_KEY_LOCATION @@ -74,6 +76,12 @@ FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --first-revision-id=FIRST_REVISION_ID + The id of the oldest revision allowed for the specified schema. + + --last-revision-id=LAST_REVISION_ID + The id of the most recent revision allowed for the specified schema + Schema resource - Name of the schema that messages published to this topic must conform to. The arguments in this group can be used to specify the attributes of this resource. diff --git a/gcloud/alpha/pubsub/topics/update b/gcloud/alpha/pubsub/topics/update index 912758c7c..faab8e5f8 100644 --- a/gcloud/alpha/pubsub/topics/update +++ b/gcloud/alpha/pubsub/topics/update @@ -6,6 +6,11 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [--clear-message-retention-duration | --message-retention-duration=MESSAGE_RETENTION_DURATION] + [--clear-schema-settings + | [--message-encoding=ENCODING (--schema=SCHEMA + : --schema-project=SCHEMA_PROJECT) + : --first-revision-id=FIRST_REVISION_ID + --last-revision-id=LAST_REVISION_ID]] [--message-storage-policy-allowed-regions=[REGION,...] | --recompute-message-storage-policy] [--topic-encryption-key=TOPIC_ENCRYPTION_KEY @@ -124,6 +129,50 @@ FLAGS seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. + At most one of these can be specified: + + --clear-schema-settings + If set, clear the Schema Settings from the topic. + + Schema settings. The schema that messages published to this topic must + conform to and the expected message encoding. + + --message-encoding=ENCODING + The encoding of messages validated against the schema. ENCODING + must be one of: json, binary. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --first-revision-id=FIRST_REVISION_ID + The id of the oldest revision allowed for the specified schema. + + --last-revision-id=LAST_REVISION_ID + The id of the most recent revision allowed for the specified schema + + Schema resource - Name of the schema that messages published to this + topic must conform to. The arguments in this group can be used to + specify the attributes of this resource. + + This must be specified. + + --schema=SCHEMA + ID of the schema or fully qualified identifier for the schema. To + set the schema attribute: + ◇ provide the argument --schema on the command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --schema-project=SCHEMA_PROJECT + Project ID of the Google Cloud project for the schema. To set the + project attribute: + ◇ provide the argument --schema on the command line with a + fully specified name; + ◇ provide the argument --schema-project on the command line; + ◇ provide the argument --project on the command line; + ◇ set the property core/project. + Message storage policy options. At most one of these can be specified: diff --git a/gcloud/alpha/recommender/recommendations/mark-dismissed b/gcloud/alpha/recommender/recommendations/mark-dismissed index c8f323e64..d42829733 100644 --- a/gcloud/alpha/recommender/recommendations/mark-dismissed +++ b/gcloud/alpha/recommender/recommendations/mark-dismissed @@ -25,7 +25,7 @@ EXAMPLES POSITIONAL ARGUMENTS RECOMMENDATION - Recommendation id which will be marked as dismissed + Recommendation ID which will be marked as dismissed REQUIRED FLAGS --etag=ETAG @@ -69,5 +69,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. These variants are also available: + + $ gcloud recommender recommendations mark-dismissed + + $ gcloud beta recommender recommendations mark-dismissed diff --git a/gcloud/alpha/resource-config/bulk-export b/gcloud/alpha/resource-config/bulk-export index 1e2b7b063..329581df7 100644 --- a/gcloud/alpha/resource-config/bulk-export +++ b/gcloud/alpha/resource-config/bulk-export @@ -5,9 +5,9 @@ NAME SYNOPSIS gcloud alpha resource-config bulk-export [--on-error=ON_ERROR; default="ignore"] [--path=PATH; default="-"] - [--resource-format=RESOURCE_FORMAT] [--storage-path=STORAGE_PATH] + [--resource-format=RESOURCE_FORMAT] [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] - [--resource-types=[RESOURCE_TYPE,...] + [--storage-path=STORAGE_PATH | --resource-types=[RESOURCE_TYPE,...] | --resource-types-file=RESOURCE_TYPE_FILE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -67,9 +67,8 @@ FLAGS Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. - --storage-path=STORAGE_PATH - Google Cloud Storage path where a Cloud Asset Inventory export will be - stored, example: gs://your-bucket-name/your/prefix/path + RESOURCE PARENT FLAG - specify one of the following to determine the scope + of exported resources. At most one of these can be specified: @@ -82,22 +81,35 @@ FLAGS --project=PROJECT Project ID + Select storage-path if you want to specify the Google Cloud Storage bucket + bulk-export should use for Cloud Asset Inventory Export. Alternatively, + you can provide a RESOURCE TYPE FILTER to filter resources. Filtering + resources does not use Google Cloud Storage to export resources. + At most one of these can be specified: - --resource-types=[RESOURCE_TYPE,...] - List of Config Connector KRM Kinds to export. For a full list of - supported resource types for a given parent scope run: + --storage-path=STORAGE_PATH + Google Cloud Storage path where a Cloud Asset Inventory export will + be stored, example: gs://your-bucket-name/your/prefix/path - $ gcloud alpha resource-config list-resource-types \ - --[project|organization|folder]= + RESOURCE TYPE FILTERS - specify resource types to export. - --resource-types-file=RESOURCE_TYPE_FILE - A comma (',') or newline ('\n') separated file containing the list of - Config Connector KRM Kinds to export. For a full list of supported - resource types for a given parent scope run: + At most one of these can be specified: - $ gcloud alpha resource-config list-resource-types \ - --[project|organization|folder]= + --resource-types=[RESOURCE_TYPE,...] + List of Config Connector KRM Kinds to export. For a full list of + supported resource types for a given parent scope run: + + $ gcloud alpha resource-config list-resource-types \ + --[project|organization|folder]= + + --resource-types-file=RESOURCE_TYPE_FILE + A comma (',') or newline ('\n') separated file containing the list + of Config Connector KRM Kinds to export. For a full list of + supported resource types for a given parent scope run: + + $ gcloud alpha resource-config list-resource-types \ + --[project|organization|folder]= GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/resource-config/list-resource-types b/gcloud/alpha/resource-config/list-resource-types index 7fdaeec3f..ba7d59e81 100644 --- a/gcloud/alpha/resource-config/list-resource-types +++ b/gcloud/alpha/resource-config/list-resource-types @@ -26,6 +26,9 @@ EXAMPLES --project=my-project FLAGS + RESOURCE PARENT FLAG - specify one of the following to determine the scope + of exported resources. + At most one of these can be specified: --folder=FOLDER diff --git a/gcloud/alpha/sql/users/create b/gcloud/alpha/sql/users/create index 3187ac4d7..68e83ef8a 100644 --- a/gcloud/alpha/sql/users/create +++ b/gcloud/alpha/sql/users/create @@ -28,13 +28,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). --password=PASSWORD Cloud SQL user's password. diff --git a/gcloud/alpha/sql/users/delete b/gcloud/alpha/sql/users/delete index 7645a3a1c..44819adf0 100644 --- a/gcloud/alpha/sql/users/delete +++ b/gcloud/alpha/sql/users/delete @@ -24,13 +24,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/sql/users/describe b/gcloud/alpha/sql/users/describe index 6f4709a2c..b8c31f5c8 100644 --- a/gcloud/alpha/sql/users/describe +++ b/gcloud/alpha/sql/users/describe @@ -26,13 +26,13 @@ REQUIRED FLAGS OPTIONAL FLAGS --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, @@ -46,5 +46,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta sql users describe diff --git a/gcloud/alpha/sql/users/set-password b/gcloud/alpha/sql/users/set-password index cf879284c..d75e58537 100644 --- a/gcloud/alpha/sql/users/set-password +++ b/gcloud/alpha/sql/users/set-password @@ -26,13 +26,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). At most one of these can be specified: diff --git a/gcloud/alpha/sql/users/set-password-policy b/gcloud/alpha/sql/users/set-password-policy index 5d871423b..108b611f8 100644 --- a/gcloud/alpha/sql/users/set-password-policy +++ b/gcloud/alpha/sql/users/set-password-policy @@ -47,13 +47,13 @@ OPTIONAL FLAGS Postgres. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). --password-policy-allowed-failed-attempts=PASSWORD_POLICY_ALLOWED_FAILED_ATTEMPTS Number of failed login attempts allowed before a user is locked out. diff --git a/gcloud/beta/ai/custom-jobs/create b/gcloud/beta/ai/custom-jobs/create index bf24b193e..8a205352c 100644 --- a/gcloud/beta/ai/custom-jobs/create +++ b/gcloud/beta/ai/custom-jobs/create @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta ai custom-jobs create --display-name=DISPLAY_NAME (--config=CONFIG --worker-pool-spec=[WORKER_POOL_SPEC,...]) - [--args=[ARG,...]] [--command=[COMMAND,...]] [--enable-web-access] + [--args=[ARG,...]] [--command=[COMMAND,...]] + [--enable-dashboard-access] [--enable-web-access] [--labels=[KEY=VALUE,...]] [--network=NETWORK] [--python-package-uris=[PYTHON_PACKAGE_URIS,...]] [--region=REGION] [--service-account=SERVICE_ACCOUNT] @@ -167,6 +168,12 @@ OPTIONAL FLAGS Command to be invoked when containers are started. It overrides the entrypoint instruction in Dockerfile when provided. + --enable-dashboard-access + Whether you want Vertex AI to enable dashboard built on the training + containers. If set to true, you can access the dashboard at the URIs + given by CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + --enable-web-access Whether you want Vertex AI to enable interactive shell access (https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) diff --git a/gcloud/beta/ai/hp-tuning-jobs/create b/gcloud/beta/ai/hp-tuning-jobs/create index 9effdb32f..a2125ad0f 100644 --- a/gcloud/beta/ai/hp-tuning-jobs/create +++ b/gcloud/beta/ai/hp-tuning-jobs/create @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta ai hp-tuning-jobs create --config=CONFIG --display-name=DISPLAY_NAME [--algorithm=ALGORITHM] - [--enable-web-access] [--labels=[KEY=VALUE,...]] + [--enable-dashboard-access] [--enable-web-access] + [--labels=[KEY=VALUE,...]] [--max-trial-count=MAX_TRIAL_COUNT; default=1] [--network=NETWORK] [--parallel-trial-count=PARALLEL_TRIAL_COUNT; default=1] [--region=REGION] [--service-account=SERVICE_ACCOUNT] @@ -60,6 +61,12 @@ OPTIONAL FLAGS Search algorithm specified for the given study. ALGORITHM must be one of: algorithm-unspecified, grid-search, random-search. + --enable-dashboard-access + Whether you want Vertex AI to enable dashboard built on the training + containers. If set to true, you can access the dashboard at the URIs + given by CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + --enable-web-access Whether you want Vertex AI to enable interactive shell access (https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) diff --git a/gcloud/beta/ai/models/upload b/gcloud/beta/ai/models/upload index 555250a8b..9c05057b3 100644 --- a/gcloud/beta/ai/models/upload +++ b/gcloud/beta/ai/models/upload @@ -147,6 +147,9 @@ OPTIONAL FLAGS Resource name of the model into which to upload the version. Only specify this field when uploading a new version. + Value should be provided in format: + projects/PROJECT_ID/locations/REGION/models/PARENT_MODEL_ID + Region resource - Cloud region to upload model. 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: diff --git a/gcloud/beta/builds/connections/add-iam-policy-binding b/gcloud/beta/builds/connections/add-iam-policy-binding new file mode 100644 index 000000000..6ce1dd3ec --- /dev/null +++ b/gcloud/beta/builds/connections/add-iam-policy-binding @@ -0,0 +1,128 @@ +NAME + gcloud beta builds connections add-iam-policy-binding - add IAM policy + binding to a Cloud Build connection + +SYNOPSIS + gcloud beta builds connections add-iam-policy-binding + (CONNECTION : --region=REGION) --member=PRINCIPAL --role=ROLE + [--condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Add IAM policy binding to a Cloud Build connection. One binding + consists of a member and a role. + +EXAMPLES + To add an IAM policy binding for the role of + 'roles/cloudbuild.connectionViewer' for the user 'test-user@gmail.com' on a + Connection named 'my-conn', run: + + $ gcloud beta builds connections add-iam-policy-binding my-conn \ + --region=us-central1 --member='user:test-user@gmail.com' \ + --role='roles/cloudbuild.connectionViewer' + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build Connection for which to add the IAM + policy binding. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) 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 + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +OPTIONAL FLAGS + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the 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. This + variant is also available: + + $ gcloud alpha builds connections add-iam-policy-binding + diff --git a/gcloud/beta/builds/connections/create/github b/gcloud/beta/builds/connections/create/github new file mode 100644 index 000000000..5176e94d3 --- /dev/null +++ b/gcloud/beta/builds/connections/create/github @@ -0,0 +1,112 @@ +NAME + gcloud beta builds connections create github - create a Cloud Build + Connection of type GitHub + +SYNOPSIS + gcloud beta builds connections create github (CONNECTION : --region=REGION) + [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + : --app-installation-id=APP_INSTALLATION_ID] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Cloud Build Connection of type GitHub (for github.com). + + Connections for github.com can be created either by following an + installation process (that requires manual steps in a web browser) or by + providing the properties of an already-installed application (installation + ID and a user token) as arguments to this command. + +EXAMPLES + To create a connection by following the installation process, provide only + the connection name: + + $ gcloud beta builds connections create github myconn \ + --project=myproj --region=us-central1 + + The command will print a URL to be opened in a web browser in order to + authorize Cloud Build (i.e. Cloud Build gets an OAuth token for the github + account that you use). After doing this authorization, you can get the + connection's installation state with the describe command: + + $ gcloud alpha builds connections describe myconn + + The output will include a second link to install the Cloud Build GitHub + App. After doing this, the connection will be in installation state + COMPLETE and repositories can be added to it (see gcloud alpha builds + repositories create). + + -- + + To create a complete connection (e.g. based on an existing user token and + installation), provide both the authorizer secret token and the app + installation id: + + $ gcloud beta builds connections create github myconn \ + --project=myproj --region=us-central1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + mytoken/versions/1 --app-installation-id=1234 + + Above command creates the connection in installation state COMPLETE, ready + for adding repositories. + +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. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Group of arguments for configuring a complete connnection. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the authorizer user's token. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --app-installation-id=APP_INSTALLATION_ID + Installation ID of the Cloud Build GitHub App. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This + variant is also available: + + $ gcloud alpha builds connections create github + diff --git a/gcloud/beta/builds/connections/create/github-enterprise b/gcloud/beta/builds/connections/create/github-enterprise new file mode 100644 index 000000000..1a19a40de --- /dev/null +++ b/gcloud/beta/builds/connections/create/github-enterprise @@ -0,0 +1,166 @@ +NAME + gcloud beta builds connections create github-enterprise - create a Cloud + Build Connection of type GitHub Enterprise + +SYNOPSIS + gcloud beta builds connections create github-enterprise + (CONNECTION : --region=REGION) --host-uri=HOST_URI [--async] + [--app-id=APP_ID --app-slug=APP_SLUG + --private-key-secret-version=PRIVATE_KEY_SECRET_VERSION + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + : --app-installation-id=APP_INSTALLATION_ID] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE + : --ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Cloud Build Connection of type GitHub Enterprise. + + Connections for GitHub Enterprise can be created either by following an + intallation process (that requires manual steps in a web browser) or by + providing all the properties of an already-installed application as + arguments to this command. + + If the GitHub Enterprise server can only be accessed within a VPC, a + Service Directory service resource can be provided for connecting to it. + +EXAMPLES + To create a connection by following the installation process, provide only + the connection name and the host URI. If the server can only be accessed + within a VPC, provide also the Service Directory service resource: + + $ gcloud beta builds connections create github-enterprise \ + my-ghe-conn --project=myproj --region=us-central1 \ + --host-uri=https://my.ghe-server.net \ + --service-directory-service=projects/myproj/namespaces/x/\ + services/mysds + + The command will print a URL to be opened in a web browser in order create + and install a GitHub App in that server. After following the URL, you can + get the connection's installation state with The describe command: + + $ gcloud alpha builds connections describe my-ghe-conn \ + --region=us-central1 + + If the connection's installation state is not COMPLETE yet, it will provide + a link to continue the installation process. Once the connection is in + installation state COMPLETE, repositories can be added to it (see gcloud + alpha builds repositories create). + + -- + + To create a complete connection (e.g. based on an existing installation), + provide all the parameters: + + $ gcloud beta builds connections create github-enterprise \ + my-ghe-conn --project=myproj --region=us-central1 --app-id=111 \ + --app-slug=gcb-app \ + --service-directory-service=projects/myproj/namespaces/x/\ + services/mysds \ + --private-key-secret-version=projects/myproj/secrets/pk/\ + versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 --app-slug=myapp --app-installation-id=1234 + + Above command creates the connection in installation state COMPLETE, ready + for adding repositories. + +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 + --host-uri=HOST_URI + URI of the GitHub Enterprise server. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Group of arguments for the GitHub App properties. + + --app-id=APP_ID + App ID of the GitHub App in the GitHub Enterprise server. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --app-slug=APP_SLUG + App slug (url-friendly name) of the GitHub App. When seeing the + configuration page of the App (e.g. in + https://my-ghe-server.net/settings/apps/my-app), the app-slug is the + last component of the URL path ("my-app" in that example). + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --private-key-secret-version=PRIVATE_KEY_SECRET_VERSION + Secret containing the private key of the GitHub App. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events generated by the GitHub App. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --app-installation-id=APP_INSTALLATION_ID + Installation ID of the Cloud Build GitHub App. + + Group of arguments for configuring access through Service Directory. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the GitHub + Enterprise Server. 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. This + variant is also available: + + $ gcloud alpha builds connections create github-enterprise + diff --git a/gcloud/beta/builds/connections/create/help b/gcloud/beta/builds/connections/create/help new file mode 100644 index 000000000..91169057d --- /dev/null +++ b/gcloud/beta/builds/connections/create/help @@ -0,0 +1,30 @@ +NAME + gcloud beta builds connections create - create Connections in Google Cloud + Build + +SYNOPSIS + gcloud beta builds connections create COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create Connections in Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + github + (BETA) Create a Cloud Build Connection of type GitHub. + + github-enterprise + (BETA) Create a Cloud Build Connection of type GitHub Enterprise. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha builds connections create + diff --git a/gcloud/beta/builds/connections/delete b/gcloud/beta/builds/connections/delete new file mode 100644 index 000000000..f5096b888 --- /dev/null +++ b/gcloud/beta/builds/connections/delete @@ -0,0 +1,66 @@ +NAME + gcloud beta builds connections delete - delete a Cloud Build Connection + +SYNOPSIS + gcloud beta builds connections delete (CONNECTION : --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Cloud Build Connection. + +EXAMPLES + To delete Cloud Build connection my-conn in region us-central1, run the + following command: + + $ gcloud beta builds connections delete my-conn --region=us-central1 + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build connection to delete. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This + variant is also available: + + $ gcloud alpha builds connections delete + diff --git a/gcloud/beta/builds/connections/describe b/gcloud/beta/builds/connections/describe new file mode 100644 index 000000000..c2ff9350e --- /dev/null +++ b/gcloud/beta/builds/connections/describe @@ -0,0 +1,62 @@ +NAME + gcloud beta builds connections describe - describe a Cloud Build Connection + +SYNOPSIS + gcloud beta builds connections describe (CONNECTION : --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Cloud Build Connection. + +EXAMPLES + To describe a Connection my-conn in region us-central1, run the following + command: + + $ gcloud beta builds connections describe my-conn \ + --region=us-central1 + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build Connection to describe. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This + variant is also available: + + $ gcloud alpha builds connections describe + diff --git a/gcloud/beta/builds/connections/get-iam-policy b/gcloud/beta/builds/connections/get-iam-policy new file mode 100644 index 000000000..9d775cea6 --- /dev/null +++ b/gcloud/beta/builds/connections/get-iam-policy @@ -0,0 +1,90 @@ +NAME + gcloud beta builds connections get-iam-policy - get the IAM policy for a + Cloud Build connection + +SYNOPSIS + gcloud beta builds connections get-iam-policy + (CONNECTION : --region=REGION) [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Get the IAM policy for a Cloud Build connection. + +EXAMPLES + To print the IAM policy for a Connection named 'my-conn', run the following + command: + + $ gcloud beta builds connections get-iam-policy my-conn \ + --region=us-central1 + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build Connection from which to get IAM policy. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument 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. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the 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. This + variant is also available: + + $ gcloud alpha builds connections get-iam-policy + diff --git a/gcloud/beta/builds/connections/help b/gcloud/beta/builds/connections/help new file mode 100644 index 000000000..e7105c8a7 --- /dev/null +++ b/gcloud/beta/builds/connections/help @@ -0,0 +1,50 @@ +NAME + gcloud beta builds connections - manage connections for Google Cloud Build + +SYNOPSIS + gcloud beta builds connections GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage connections for Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + create + (BETA) Create Connections in Google Cloud Build. + + update + (BETA) Update Connections in Google Cloud Build. + +COMMANDS + COMMAND is one of the following: + + add-iam-policy-binding + (BETA) Add IAM policy binding to a Cloud Build connection. + + delete + (BETA) Delete a Cloud Build Connection. + + describe + (BETA) Describe a Cloud Build Connection. + + get-iam-policy + (BETA) Get the IAM policy for a Cloud Build connection. + + list + (BETA) List all Cloud Build connections for a project and region. + + set-iam-policy + (BETA) Set the IAM policy for a Cloud Build connection. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha builds connections + diff --git a/gcloud/database-migration/conversion-workspaces/list b/gcloud/beta/builds/connections/list similarity index 64% rename from gcloud/database-migration/conversion-workspaces/list rename to gcloud/beta/builds/connections/list index 557f1b432..dbde3ad5c 100644 --- a/gcloud/database-migration/conversion-workspaces/list +++ b/gcloud/beta/builds/connections/list @@ -1,38 +1,37 @@ NAME - gcloud database-migration conversion-workspaces list - list conversion - workspaces + gcloud beta builds connections list - list all Cloud Build connections for + a project and region SYNOPSIS - gcloud database-migration conversion-workspaces list --region=REGION - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + gcloud beta builds connections list [--region=REGION] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List conversion workspaces. + (BETA) List all Cloud Build connections for a project and region. EXAMPLES - To list all conversion workspaces in a project and location us-central1, - run: + To list all the Cloud Build connections in region us-central1, run the + following command: - $ gcloud database-migration conversion-workspaces list \ - --region=us-central1 + $ gcloud beta builds connections list --region=us-central1 -REQUIRED FLAGS - Region resource - The region you want to list the conversion workspaces - for. This represents a Cloud resource. (NOTE) Some attributes are not - given arguments in this group but can be set in other ways. To set the - project attribute: +FLAGS + Region resource - Cloud Build location to list all contained connections. + This represents a Cloud resource. (NOTE) Some attributes are not given + arguments in this group but can be set in other ways. To set the project + attribute: ◆ provide the argument --region on the command line with a fully specified name; + ◆ set the property builds/region with a fully specified name; ◆ provide the argument --project on the command line; ◆ set the property core/project. - This must be specified. - --region=REGION ID of the region or fully qualified identifier for the region. To set the region attribute: - ▸ provide the argument --region on the command line. + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. LIST COMMAND FLAGS --filter=EXPRESSION @@ -75,5 +74,12 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. API REFERENCE - This command uses the datamigration/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/database-migration/ + 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. This + variant is also available: + + $ gcloud alpha builds connections list + diff --git a/gcloud/beta/builds/connections/set-iam-policy b/gcloud/beta/builds/connections/set-iam-policy new file mode 100644 index 000000000..7afd2f8df --- /dev/null +++ b/gcloud/beta/builds/connections/set-iam-policy @@ -0,0 +1,74 @@ +NAME + gcloud beta builds connections set-iam-policy - set the IAM policy for a + Cloud Build connection + +SYNOPSIS + gcloud beta builds connections set-iam-policy + (CONNECTION : --region=REGION) POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Set the IAM policy for a Cloud Build connection as defined in a JSON + or YAML file. + + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + 'policy.json' and set it for the Connection named 'my-conn': + + $ gcloud beta builds connections set-iam-policy my-conn \ + policy.json --region=us-central1 + +POSITIONAL ARGUMENTS + Connection resource - Cloud Build Connection for which to set IAM policy. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument 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. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the 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. This + variant is also available: + + $ gcloud alpha builds connections set-iam-policy + diff --git a/gcloud/beta/builds/connections/update/github b/gcloud/beta/builds/connections/update/github new file mode 100644 index 000000000..477fb4a44 --- /dev/null +++ b/gcloud/beta/builds/connections/update/github @@ -0,0 +1,84 @@ +NAME + gcloud beta builds connections update github - update a Cloud Build + Connection of type GitHub + +SYNOPSIS + gcloud beta builds connections update github (CONNECTION : --region=REGION) + [--app-installation-id=APP_INSTALLATION_ID] [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Cloud Build Connection of type GitHub (for github.com). + +EXAMPLES + To update the authorizer token, provide the connection name and the + authorizer token secret: + + $ gcloud beta builds connections update github myconn \ + --region=us-central1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + mytoken/versions/1 + + To update the installation id, provide the connection name and the + installation id of the Cloud Build GitHub app. + + $ gcloud beta builds connections update github myconn \ + --region=us-central1 --app-installation-id=1234 + +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 + --app-installation-id=APP_INSTALLATION_ID + Installation ID of the Cloud Build GitHub App. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the authorizer user's token. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This + variant is also available: + + $ gcloud alpha builds connections update github + diff --git a/gcloud/beta/builds/connections/update/github-enterprise b/gcloud/beta/builds/connections/update/github-enterprise new file mode 100644 index 000000000..0bf1dbaad --- /dev/null +++ b/gcloud/beta/builds/connections/update/github-enterprise @@ -0,0 +1,110 @@ +NAME + gcloud beta builds connections update github-enterprise - update a Cloud + Build Connection of type GitHub Enterprise + +SYNOPSIS + gcloud beta builds connections update github-enterprise + (CONNECTION : --region=REGION) [--app-id=APP_ID] + [--app-installation-id=APP_INSTALLATION_ID] [--app-slug=APP_SLUG] + [--async] [--host-uri=HOST_URI] + [--private-key-secret-version=PRIVATE_KEY_SECRET_VERSION] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE] + [--ssl-ca-file=SSL_CA_FILE] + [--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Cloud Build Connection of type GitHub Enterprise. + +EXAMPLES + To update the ssl_ca, provide the connection name and the ssl_ca file: + + $ gcloud beta builds connections update github-enterprise \ + my-ghe-conn --region=us-west1 --ssl-ca-file=mycertificate.crt + + To update the installation id, provide the connection name and the + installation id of the Cloud Build GitHub app. + + $ gcloud beta builds connections update github-enterprise \ + my-ghe-conn --region=us-west1 --app-installation-id=1234 + +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 + --app-id=APP_ID + App ID of the GitHub App in the GitHub Enterprise server. + + --app-installation-id=APP_INSTALLATION_ID + Installation ID of the Cloud Build GitHub App. + + --app-slug=APP_SLUG + App slug (url-friendly name) of the GitHub App. When seeing the + configuration page of the App (e.g. in + https://my-ghe-server.net/settings/apps/my-app), the app-slug is the + last component of the URL path ("my-app" in that example). + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --host-uri=HOST_URI + URI of the GitHub Enterprise server. + + --private-key-secret-version=PRIVATE_KEY_SECRET_VERSION + Secret containing the private key of the GitHub App. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the GitHub + Enterprise Server. 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. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events generated by the GitHub App. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This + variant is also available: + + $ gcloud alpha builds connections update github-enterprise + diff --git a/gcloud/beta/builds/connections/update/help b/gcloud/beta/builds/connections/update/help new file mode 100644 index 000000000..619273170 --- /dev/null +++ b/gcloud/beta/builds/connections/update/help @@ -0,0 +1,30 @@ +NAME + gcloud beta builds connections update - update Connections in Google Cloud + Build + +SYNOPSIS + gcloud beta builds connections update COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update Connections in Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + github + (BETA) Update a Cloud Build Connection of type GitHub. + + github-enterprise + (BETA) Update a Cloud Build Connection of type GitHub Enterprise. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha builds connections update + diff --git a/gcloud/beta/builds/help b/gcloud/beta/builds/help index 02b882b80..d51b9eb8a 100644 --- a/gcloud/beta/builds/help +++ b/gcloud/beta/builds/help @@ -15,6 +15,12 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + connections + (BETA) Manage connections for Google Cloud Build. + + repositories + (BETA) Manage repositories for Google Cloud Build. + triggers (BETA) Create and manage build triggers for Google Cloud Build. diff --git a/gcloud/beta/builds/repositories/create b/gcloud/beta/builds/repositories/create new file mode 100644 index 000000000..0ce1a674e --- /dev/null +++ b/gcloud/beta/builds/repositories/create @@ -0,0 +1,79 @@ +NAME + gcloud beta builds repositories create - create a Cloud Build repository + +SYNOPSIS + gcloud beta builds repositories create + (REPOSITORY : --connection=CONNECTION --region=REGION) + --remote-uri=REMOTE_URI [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Cloud Build repository in a connection. + +EXAMPLES + To Create a repository with name my-repo in the connection my-conn, run the + following command: + + $ gcloud beta builds repositories create my-repo \ + --remote-uri=https://github.com/octocat/Hello-World.git \ + --connection=my-conn --region=us-central1 + +POSITIONAL ARGUMENTS + Repository resource - Repository 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 repository 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. + + REPOSITORY + ID of the repository or fully qualified identifier for the + repository. To set the repository attribute: + ▸ provide the argument repository on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --connection=CONNECTION + Connection ID. To set the connection attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --connection on the command line. + + --region=REGION + The Google Cloud region. To set the region attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + --remote-uri=REMOTE_URI + The remote git clone URL of the repository. + +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. This + variant is also available: + + $ gcloud alpha builds repositories create + diff --git a/gcloud/beta/builds/repositories/delete b/gcloud/beta/builds/repositories/delete new file mode 100644 index 000000000..1760ca42b --- /dev/null +++ b/gcloud/beta/builds/repositories/delete @@ -0,0 +1,74 @@ +NAME + gcloud beta builds repositories delete - delete a Cloud Build Repository + +SYNOPSIS + gcloud beta builds repositories delete + (REPOSITORY : --connection=CONNECTION --region=REGION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Cloud Build Repository in a Connection. + +EXAMPLES + To delete Cloud Build repository my-repo in connection my-conn, run the + following command: + + $ gcloud beta builds repositories delete my-repo \ + --connection=my-conn --region=us-central1 + +POSITIONAL ARGUMENTS + Repository resource - Cloud Build repository to delete. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument repository 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. + + REPOSITORY + ID of the repository or fully qualified identifier for the + repository. To set the repository attribute: + ▸ provide the argument repository on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --connection=CONNECTION + Connection ID. To set the connection attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --connection on the command line. + + --region=REGION + The Google Cloud region. To set the region attribute: + ▸ provide the argument repository 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This + variant is also available: + + $ gcloud alpha builds repositories delete + diff --git a/gcloud/beta/builds/repositories/describe b/gcloud/beta/builds/repositories/describe new file mode 100644 index 000000000..bda3ab344 --- /dev/null +++ b/gcloud/beta/builds/repositories/describe @@ -0,0 +1,69 @@ +NAME + gcloud beta builds repositories describe - describe a Cloud Build + Repository + +SYNOPSIS + gcloud beta builds repositories describe + (REPOSITORY : --connection=CONNECTION --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Cloud Build Repository. + +EXAMPLES + To list all the Cloud Build connections in region us-central1, run the + following command: + + $ gcloud beta builds repositories describe --region=us-central1 + +POSITIONAL ARGUMENTS + Repository resource - Cloud Build Repository to describe. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument repository 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. + + REPOSITORY + ID of the repository or fully qualified identifier for the + repository. To set the repository attribute: + ▸ provide the argument repository on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --connection=CONNECTION + Connection ID. To set the connection attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --connection on the command line. + + --region=REGION + The Google Cloud region. To set the region attribute: + ▸ provide the argument repository on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +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. This + variant is also available: + + $ gcloud alpha builds repositories describe + diff --git a/gcloud/beta/builds/repositories/help b/gcloud/beta/builds/repositories/help new file mode 100644 index 000000000..bc80eb51a --- /dev/null +++ b/gcloud/beta/builds/repositories/help @@ -0,0 +1,36 @@ +NAME + gcloud beta builds repositories - manage repositories for Google Cloud + Build + +SYNOPSIS + gcloud beta builds repositories COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage repositories for Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create a Cloud Build repository. + + delete + (BETA) Delete a Cloud Build Repository. + + describe + (BETA) Describe a Cloud Build Repository. + + list + (BETA) List all Cloud Build repositories in a connection. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha builds repositories + diff --git a/gcloud/beta/builds/repositories/list b/gcloud/beta/builds/repositories/list new file mode 100644 index 000000000..5a60b2155 --- /dev/null +++ b/gcloud/beta/builds/repositories/list @@ -0,0 +1,98 @@ +NAME + gcloud beta builds repositories list - list all Cloud Build repositories in + a connection + +SYNOPSIS + gcloud beta builds repositories list + (--connection=CONNECTION : --region=REGION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List all Cloud Build repositories in a connection. + +EXAMPLES + To list all the repositories in the Cloud Build connection my-conn, run the + following command: + + $ gcloud beta builds repositories list --connection=my-conn \ + --region=us-central1 + +REQUIRED FLAGS + Connection resource - Cloud Build connection to list all contained + repositories. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) 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=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 flag 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. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the 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. This + variant is also available: + + $ gcloud alpha builds repositories list + diff --git a/gcloud/beta/builds/worker-pools/create b/gcloud/beta/builds/worker-pools/create index 17e299078..5afa4face 100644 --- a/gcloud/beta/builds/worker-pools/create +++ b/gcloud/beta/builds/worker-pools/create @@ -59,15 +59,15 @@ OPTIONAL FLAGS --peered-network-ip-range=PEERED_NETWORK_IP_RANGE An IP range for your peered network. Specify the IP range using Classless Inter-Domain Routing (CIDR) notation with a slash and the - subnet prefix size, such as '/29'. + subnet prefix size, such as /29. Your subnet prefix size must be between 1 and 29. Optional: you can specify an IP address before the subnet prefix value - for example - 192.168.0.1/24. + 192.168.0.0/24. If no IP address is specified, your VPC automatically determines the starting IP for the range. If no IP range is specified, Cloud - Build uses '/24' as the default network IP range. + Build uses /24 as the default network IP range. --no-public-egress If set, workers in the worker pool are created without an external diff --git a/gcloud/beta/compute/firewall-policies/rules/create b/gcloud/beta/compute/firewall-policies/rules/create index 1e25c06f4..48c73d677 100644 --- a/gcloud/beta/compute/firewall-policies/rules/create +++ b/gcloud/beta/compute/firewall-policies/rules/create @@ -65,7 +65,9 @@ OPTIONAL FLAGS --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] Destination Threat Intelligence lists to match for this rule. Can only - be specified if DIRECTION is egress. + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --direction=DIRECTION Direction of the traffic the rule is applied. The default is to apply @@ -105,7 +107,9 @@ OPTIONAL FLAGS --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] Source Threat Intelligence lists to match for this rule. Can only be - specified if DIRECTION is ingress. + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --target-resources=[TARGET_RESOURCES,...] List of URLs of target resources to which the rule is applied. diff --git a/gcloud/beta/compute/firewall-policies/rules/update b/gcloud/beta/compute/firewall-policies/rules/update index 000faa7af..257bd53ef 100644 --- a/gcloud/beta/compute/firewall-policies/rules/update +++ b/gcloud/beta/compute/firewall-policies/rules/update @@ -68,7 +68,9 @@ OPTIONAL FLAGS --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] Destination Threat Intelligence lists to match for this rule. Can only - be specified if DIRECTION is egress. + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --direction=DIRECTION Direction of the traffic the rule is applied. The default is to apply @@ -111,7 +113,9 @@ OPTIONAL FLAGS --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] Source Threat Intelligence lists to match for this rule. Can only be - specified if DIRECTION is ingress. + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --target-resources=[TARGET_RESOURCES,...] List of URLs of target resources to which the rule is applied. diff --git a/gcloud/beta/compute/instance-groups/managed/create b/gcloud/beta/compute/instance-groups/managed/create index 85edda580..7647d873c 100644 --- a/gcloud/beta/compute/instance-groups/managed/create +++ b/gcloud/beta/compute/instance-groups/managed/create @@ -17,7 +17,13 @@ SYNOPSIS [--zones=ZONE,[ZONE,...]] [--health-check=HEALTH_CHECK | --http-health-check=HTTP_HEALTH_CHECK | --https-health-check=HTTPS_HEALTH_CHECK] - [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--region=REGION | --zone=ZONE] + [--update-policy-max-surge=MAX_SURGE + --update-policy-max-unavailable=MAX_UNAVAILABLE + --update-policy-min-ready=MIN_READY + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD --update-policy-type=UPDATE_TYPE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta compute instance-groups managed create creates a Compute @@ -278,6 +284,97 @@ OPTIONAL FLAGS Overrides the default compute/zone property value for this command invocation. + Parameters for setting update policy for this managed instance group. + + --update-policy-max-surge=MAX_SURGE + Maximum additional number of VMs that can be created during the + update process. This can be a fixed number (e.g. 5) or a percentage + of size to the managed instance group (e.g. 10%). Defaults to 0 if + the managed instance group has stateful configuration, or to the + number of zones in which it operates otherwise. + + --update-policy-max-unavailable=MAX_UNAVAILABLE + Maximum number of VMs that can be unavailable during the update + process. This can be a fixed number (e.g. 5) or a percentage of size + to the managed instance group (e.g. 10%). Defaults to the number of + zones in which the managed instance group operates. + + --update-policy-min-ready=MIN_READY + Minimum time for which a newly created VM should be ready to be + considered available. For example 10s for 10 seconds. See $ gcloud + topic datetimes for information on duration formats. + + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + Use this flag to minimize disruption as much as possible or to apply + a more disruptive action than is strictly necessary. The MIG performs + at least this action on each VM while updating. If the update + requires a more disruptive action than the one specified here, then + the more disruptive action is performed. UPDATE_POLICY_MINIMAL_ACTION + must be one of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION + Use this flag to prevent an update if it requires more disruption + than you can afford. At most, the MIG performs the specified action + on each VM while updating. If the update requires a more disruptive + action than the one specified here, then the update fails and no + changes are made. UPDATE_POLICY_MOST_DISRUPTIVE_ACTION must be one + of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD + Type of replacement method. Specifies what action will be taken to + update VMs. Defaults to ``recreate`` if the managed instance group + has stateful configuration, or to ``substitute`` otherwise. + UPDATE_POLICY_REPLACEMENT_METHOD must be one of: + + recreate + Recreate VMs and preserve the VM names. The VM IDs and creation + timestamps might change. + substitute + Delete old VMs and create VMs with new names. + + --update-policy-type=UPDATE_TYPE + Specifies the type of update process. You can specify either + ``proactive`` so that the managed instance group proactively executes + actions in order to bring VMs to their target versions or + ``opportunistic`` so that no action is proactively executed but the + update will be performed as part of other actions. UPDATE_TYPE must + be one of: + + opportunistic + Do not proactively replace VMs. Create new VMs and delete old + ones on resizes of the group and when you target specific VMs to + be updated or recreated. + proactive + Replace VMs proactively. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/compute/instance-groups/managed/instance-configs/create b/gcloud/beta/compute/instance-groups/managed/instance-configs/create index aeaae1c34..57fbc4c86 100644 --- a/gcloud/beta/compute/instance-groups/managed/instance-configs/create +++ b/gcloud/beta/compute/instance-groups/managed/instance-configs/create @@ -73,15 +73,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME],[mode=MODE],[source=SOURCE] Disks considered stateful by the instance group. Managed instance diff --git a/gcloud/beta/compute/instance-groups/managed/instance-configs/delete b/gcloud/beta/compute/instance-groups/managed/instance-configs/delete index fbd3a4999..7abfe4f51 100644 --- a/gcloud/beta/compute/instance-groups/managed/instance-configs/delete +++ b/gcloud/beta/compute/instance-groups/managed/instance-configs/delete @@ -45,15 +45,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --update-instance Apply the configuration changes immediately to the instance. If you diff --git a/gcloud/beta/compute/instance-groups/managed/instance-configs/update b/gcloud/beta/compute/instance-groups/managed/instance-configs/update index 06342b48d..7ee3fead2 100644 --- a/gcloud/beta/compute/instance-groups/managed/instance-configs/update +++ b/gcloud/beta/compute/instance-groups/managed/instance-configs/update @@ -80,15 +80,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --remove-stateful-disks=DEVICE_NAME,[DEVICE_NAME,...] Remove stateful configuration for the specified disks from the diff --git a/gcloud/beta/compute/instance-groups/managed/rolling-action/replace b/gcloud/beta/compute/instance-groups/managed/rolling-action/replace index a9418387d..d065e6e79 100644 --- a/gcloud/beta/compute/instance-groups/managed/rolling-action/replace +++ b/gcloud/beta/compute/instance-groups/managed/rolling-action/replace @@ -38,8 +38,8 @@ FLAGS --replacement-method=REPLACEMENT_METHOD Type of replacement method. Specifies what action will be taken to - update instances. Defaults to recreate if the managed instance group - has stateful configuration, or to substitute otherwise. + update instances. Defaults to ``recreate`` if the managed instance + group has stateful configuration, or to ``substitute`` otherwise. REPLACEMENT_METHOD must be one of: recreate diff --git a/gcloud/beta/compute/instance-groups/managed/rolling-action/start-update b/gcloud/beta/compute/instance-groups/managed/rolling-action/start-update index da1037140..e6054a294 100644 --- a/gcloud/beta/compute/instance-groups/managed/rolling-action/start-update +++ b/gcloud/beta/compute/instance-groups/managed/rolling-action/start-update @@ -38,8 +38,9 @@ COMMONLY USED FLAGS Desired update type. TYPE must be one of: opportunistic - Do not proactively replace instances. Create new instances and - delete old on resizes of the group. + Do not proactively replace VMs. Create new VMs and delete old ones + on resizes of the group and when you target specific VMs to be + updated or recreated. proactive Replace instances proactively. @@ -78,15 +79,15 @@ OTHER FLAGS MINIMAL_ACTION must be one of: refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --most-disruptive-allowed-action=MOST_DISRUPTIVE_ALLOWED_ACTION Use this flag to prevent an update if it requires more disruption than @@ -100,20 +101,20 @@ OTHER FLAGS MOST_DISRUPTIVE_ALLOWED_ACTION must be one of: refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --replacement-method=REPLACEMENT_METHOD Type of replacement method. Specifies what action will be taken to - update instances. Defaults to recreate if the managed instance group - has stateful configuration, or to substitute otherwise. + update instances. Defaults to ``recreate`` if the managed instance + group has stateful configuration, or to ``substitute`` otherwise. REPLACEMENT_METHOD must be one of: recreate diff --git a/gcloud/beta/compute/instance-groups/managed/update b/gcloud/beta/compute/instance-groups/managed/update index b352f0cea..ae4ea4e40 100644 --- a/gcloud/beta/compute/instance-groups/managed/update +++ b/gcloud/beta/compute/instance-groups/managed/update @@ -20,14 +20,27 @@ SYNOPSIS | --initial-delay=INITIAL_DELAY --health-check=HEALTH_CHECK | --http-health-check=HTTP_HEALTH_CHECK | --https-health-check=HTTPS_HEALTH_CHECK] - [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--region=REGION | --zone=ZONE] + [--update-policy-max-surge=MAX_SURGE + --update-policy-max-unavailable=MAX_UNAVAILABLE + --update-policy-min-ready=MIN_READY + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD --update-policy-type=UPDATE_TYPE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Update a Compute Engine managed instance group. gcloud beta compute instance-groups managed update allows you to specify or - modify the stateful policy and autohealing policy for an existing managed - instance group. + modify the description and group policies for an existing managed instance + group, including the group's update policy and optional autohealing and + stateful policies + + The group's update policy defines how an updated VM configuration is + applied to existing VMs in the group. For more information, see [Applying + new configurations] + (https://cloud.google.com/compute/docs/instance-groups/updating-migs) to + VMs in a MIG. A stateful policy defines which resources should be preserved across the group. When instances in the group are recreated, stateful resources are @@ -290,6 +303,97 @@ FLAGS Overrides the default compute/zone property value for this command invocation. + Parameters for setting update policy for this managed instance group. + + --update-policy-max-surge=MAX_SURGE + Maximum additional number of VMs that can be created during the + update process. This can be a fixed number (e.g. 5) or a percentage + of size to the managed instance group (e.g. 10%). Defaults to 0 if + the managed instance group has stateful configuration, or to the + number of zones in which it operates otherwise. + + --update-policy-max-unavailable=MAX_UNAVAILABLE + Maximum number of VMs that can be unavailable during the update + process. This can be a fixed number (e.g. 5) or a percentage of size + to the managed instance group (e.g. 10%). Defaults to the number of + zones in which the managed instance group operates. + + --update-policy-min-ready=MIN_READY + Minimum time for which a newly created VM should be ready to be + considered available. For example 10s for 10 seconds. See $ gcloud + topic datetimes for information on duration formats. + + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + Use this flag to minimize disruption as much as possible or to apply + a more disruptive action than is strictly necessary. The MIG performs + at least this action on each VM while updating. If the update + requires a more disruptive action than the one specified here, then + the more disruptive action is performed. UPDATE_POLICY_MINIMAL_ACTION + must be one of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION + Use this flag to prevent an update if it requires more disruption + than you can afford. At most, the MIG performs the specified action + on each VM while updating. If the update requires a more disruptive + action than the one specified here, then the update fails and no + changes are made. UPDATE_POLICY_MOST_DISRUPTIVE_ACTION must be one + of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD + Type of replacement method. Specifies what action will be taken to + update VMs. Defaults to ``recreate`` if the managed instance group + has stateful configuration, or to ``substitute`` otherwise. + UPDATE_POLICY_REPLACEMENT_METHOD must be one of: + + recreate + Recreate VMs and preserve the VM names. The VM IDs and creation + timestamps might change. + substitute + Delete old VMs and create VMs with new names. + + --update-policy-type=UPDATE_TYPE + Specifies the type of update process. You can specify either + ``proactive`` so that the managed instance group proactively executes + actions in order to bring VMs to their target versions or + ``opportunistic`` so that no action is proactively executed but the + update will be performed as part of other actions. UPDATE_TYPE must + be one of: + + opportunistic + Do not proactively replace VMs. Create new VMs and delete old + ones on resizes of the group and when you target specific VMs to + be updated or recreated. + proactive + Replace VMs proactively. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/compute/instance-groups/managed/update-instances b/gcloud/beta/compute/instance-groups/managed/update-instances index 241c7b4d2..a4ea9ac9c 100644 --- a/gcloud/beta/compute/instance-groups/managed/update-instances +++ b/gcloud/beta/compute/instance-groups/managed/update-instances @@ -66,15 +66,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --most-disruptive-allowed-action=MOST_DISRUPTIVE_ALLOWED_ACTION; default="replace" Use this flag to prevent an update if it requires more disruption than @@ -90,15 +90,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. At most one of these can be specified: diff --git a/gcloud/beta/compute/interconnects/attachments/dedicated/create b/gcloud/beta/compute/interconnects/attachments/dedicated/create index 02976f4a2..6ee9c5a15 100644 --- a/gcloud/beta/compute/interconnects/attachments/dedicated/create +++ b/gcloud/beta/compute/interconnects/attachments/dedicated/create @@ -135,7 +135,7 @@ OPTIONAL FLAGS Only IPv4 protocol is enabled on this attachment. --vlan=VLAN - Desired VLAN for this attachment, in the range 2-4094. If not supplied, + Desired VLAN for this attachment, in the range 2-4093. If not supplied, Google will automatically select a VLAN. GCLOUD WIDE FLAGS diff --git a/gcloud/beta/compute/network-firewall-policies/rules/create b/gcloud/beta/compute/network-firewall-policies/rules/create index 09020e23b..ed6cc5a06 100644 --- a/gcloud/beta/compute/network-firewall-policies/rules/create +++ b/gcloud/beta/compute/network-firewall-policies/rules/create @@ -75,7 +75,9 @@ OPTIONAL FLAGS --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] Destination Threat Intelligence lists to match for this rule. Can only - be specified if DIRECTION is egress. + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --direction=DIRECTION Direction of the traffic the rule is applied. The default is to apply @@ -130,7 +132,9 @@ OPTIONAL FLAGS --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] Source Threat Intelligence lists to match for this rule. Can only be - specified if DIRECTION is ingress. + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --target-secure-tags=[TARGET_SECURE_TAGS,...] An optional, list of target secure tags with a name of the format diff --git a/gcloud/beta/compute/network-firewall-policies/rules/update b/gcloud/beta/compute/network-firewall-policies/rules/update index 078bdfcad..75e553969 100644 --- a/gcloud/beta/compute/network-firewall-policies/rules/update +++ b/gcloud/beta/compute/network-firewall-policies/rules/update @@ -68,7 +68,9 @@ OPTIONAL FLAGS --dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...] Destination Threat Intelligence lists to match for this rule. Can only - be specified if DIRECTION is egress. + be specified if DIRECTION is egress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --direction=DIRECTION Direction of the traffic the rule is applied. The default is to apply @@ -126,7 +128,9 @@ OPTIONAL FLAGS --src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...] Source Threat Intelligence lists to match for this rule. Can only be - specified if DIRECTION is ingress. + specified if DIRECTION is ingress. The available lists can be found + here: + https://cloud.google.com/vpc/docs/firewall-policies-rule-details#threat-intelligence-fw-policy. --target-secure-tags=[TARGET_SECURE_TAGS,...] An optional, list of target secure tags with a name of the format diff --git a/gcloud/beta/compute/reservations/create b/gcloud/beta/compute/reservations/create index 7c246bcf0..07b557ecd 100644 --- a/gcloud/beta/compute/reservations/create +++ b/gcloud/beta/compute/reservations/create @@ -19,11 +19,22 @@ DESCRIPTION (BETA) Create a Compute Engine reservation. EXAMPLES - To create a Compute Engine reservation, run: + To create a Compute Engine reservation by specifying VM properties using an + instance template, run: $ gcloud beta compute reservations create my-reservation \ - --zone=fake-zone --vm-count=1 --machine-type=n1-standard-1 \ - --min-cpu-platform="Intel Haswell" + --vm-count=1 \ + --source-instance-template=example-instance-template \ + --zone=fake-zone + + To create a Compute Engine reservation by directly specifying VM + properties, run: + + $ gcloud beta compute reservations create my-reservation \ + --vm-count=1 --machine-type=custom-8-10240 \ + --min-cpu-platform="Intel Haswell" \ + --accelerator=count=2,type=nvidia-tesla-v100 \ + --local-ssd=size=375,interface=scsi --zone=fake-zone POSITIONAL ARGUMENTS RESERVATION diff --git a/gcloud/beta/compute/security-policies/rules/create b/gcloud/beta/compute/security-policies/rules/create index 1e6f6558e..73efeb48e 100644 --- a/gcloud/beta/compute/security-policies/rules/create +++ b/gcloud/beta/compute/security-policies/rules/create @@ -10,6 +10,9 @@ SYNOPSIS [--ban-threshold-interval-sec=BAN_THRESHOLD_INTERVAL_SEC] [--conform-action=CONFORM_ACTION] [--description=DESCRIPTION] [--enforce-on-key=ENFORCE_ON_KEY] + [--enforce-on-key-configs=[[all],[ip],[xff-ip], + [http-cookie=HTTP_COOKIE], + [http-header=HTTP_HEADER],[http-path],[sni],[region-code]],[...]] [--enforce-on-key-name=ENFORCE_ON_KEY_NAME] [--exceed-action=EXCEED_ACTION] [--exceed-redirect-target=EXCEED_REDIRECT_TARGET] @@ -128,6 +131,29 @@ OPTIONAL FLAGS ENFORCE_ON_KEY must be one of: ip, all, http-header, xff-ip, http-cookie, http-path, sni, region-code. + --enforce-on-key-configs=[[all],[ip],[xff-ip],[http-cookie=HTTP_COOKIE],[http-header=HTTP_HEADER],[http-path],[sni],[region-code]],[...] + Specify up to 3 key type/name pairs to rate limit. Valid key types are: + + ◆ ip: each client IP address has this limit enforced separately + ◆ all: a single limit is applied to all requests matching this rule + ◆ http-header: key type takes the value of the HTTP header configured + in enforce-on-key-name as the key value + ◆ xff-ip: takes the original IP address specified in the + X-Forwarded-For header as the key + ◆ http-cookie: key type takes the value of the HTTP cookie configured + in enforce-on-key-name as the key value + ◆ http-path: key type takes the value of the URL path in the request + ◆ sni: key type takes the value of the server name indication from + the TLS session of the HTTPS request + ◆ region-code: key type takes the value of the region code from which + the request originates + + Key names are only applicable to the following key types: + ◆ http-header: The name of the HTTP header whose value is taken as + the key value. + ◆ http-cookie: The name of the HTTP cookie whose value is taken as + the key value. + --enforce-on-key-name=ENFORCE_ON_KEY_NAME Determines the key name for the rate limit key. Applicable only for the following rate limit key types: diff --git a/gcloud/beta/compute/security-policies/rules/update b/gcloud/beta/compute/security-policies/rules/update index 5952c3eda..4ed4c8ec5 100644 --- a/gcloud/beta/compute/security-policies/rules/update +++ b/gcloud/beta/compute/security-policies/rules/update @@ -9,6 +9,9 @@ SYNOPSIS [--ban-threshold-interval-sec=BAN_THRESHOLD_INTERVAL_SEC] [--conform-action=CONFORM_ACTION] [--description=DESCRIPTION] [--enforce-on-key=ENFORCE_ON_KEY] + [--enforce-on-key-configs=[[all],[ip],[xff-ip], + [http-cookie=HTTP_COOKIE], + [http-header=HTTP_HEADER],[http-path],[sni],[region-code]],[...]] [--enforce-on-key-name=ENFORCE_ON_KEY_NAME] [--exceed-action=EXCEED_ACTION] [--exceed-redirect-target=EXCEED_REDIRECT_TARGET] @@ -117,6 +120,29 @@ FLAGS ENFORCE_ON_KEY must be one of: ip, all, http-header, xff-ip, http-cookie, http-path, sni, region-code. + --enforce-on-key-configs=[[all],[ip],[xff-ip],[http-cookie=HTTP_COOKIE],[http-header=HTTP_HEADER],[http-path],[sni],[region-code]],[...] + Specify up to 3 key type/name pairs to rate limit. Valid key types are: + + ◆ ip: each client IP address has this limit enforced separately + ◆ all: a single limit is applied to all requests matching this rule + ◆ http-header: key type takes the value of the HTTP header configured + in enforce-on-key-name as the key value + ◆ xff-ip: takes the original IP address specified in the + X-Forwarded-For header as the key + ◆ http-cookie: key type takes the value of the HTTP cookie configured + in enforce-on-key-name as the key value + ◆ http-path: key type takes the value of the URL path in the request + ◆ sni: key type takes the value of the server name indication from + the TLS session of the HTTPS request + ◆ region-code: key type takes the value of the region code from which + the request originates + + Key names are only applicable to the following key types: + ◆ http-header: The name of the HTTP header whose value is taken as + the key value. + ◆ http-cookie: The name of the HTTP cookie whose value is taken as + the key value. + --enforce-on-key-name=ENFORCE_ON_KEY_NAME Determines the key name for the rate limit key. Applicable only for the following rate limit key types: diff --git a/gcloud/beta/container/clusters/upgrade b/gcloud/beta/container/clusters/upgrade index d9f1fc9e0..7b3549016 100644 --- a/gcloud/beta/container/clusters/upgrade +++ b/gcloud/beta/container/clusters/upgrade @@ -11,35 +11,37 @@ SYNOPSIS DESCRIPTION (BETA) Upgrades the Kubernetes version of an existing container cluster. - This command upgrades the Kubernetes version of the nodes or master of a - cluster. Note that the Kubernetes version of the cluster's master is also + This command upgrades the Kubernetes version of the node pools or master of + a cluster. Note that the Kubernetes version of the cluster's master is also periodically upgraded automatically as new releases are available. - If desired cluster version is omitted, node upgrades default to the current - master version and master upgrades default to the default cluster version, - which can be found in the server config. + If desired cluster version is omitted, node pool upgrades default to the + current master version and master upgrades default to the default cluster + version, which can be found in the server config. - By running this command, all of the cluster's nodes will be deleted and - recreated one at a time. While persistent Kubernetes resources, such as - pods backed by replication controllers, will be rescheduled onto new nodes, - a small cluster may experience a few minutes where there are insufficient - nodes available to run all of the scheduled Kubernetes resources. + During node pool upgrades, nodes will be deleted and recreated. While + persistent Kubernetes resources, such as Pods backed by replication + controllers, will be rescheduled onto new nodes, a small cluster may + experience a few minutes where there are insufficient nodes available to + run all of the scheduled Kubernetes resources. Please ensure that any data you wish to keep is stored on a persistent disk before upgrading the cluster. Ephemeral Kubernetes resources--in - particular, pods without replication controllers--will be lost, while + particular, Pods without replication controllers--will be lost, while persistent Kubernetes resources will get rescheduled. EXAMPLES - Upgrade the nodes of sample-cluster to the Kubernetes version of the - cluster's master. - - $ gcloud beta container clusters upgrade sample-cluster - - Upgrade the nodes of sample-cluster to Kubernetes version 1.14.7-gke.14: + Upgrade the node pool pool-1 of sample-cluster to the Kubernetes version of + the cluster's master. $ gcloud beta container clusters upgrade sample-cluster \ - --cluster-version="1.14.7-gke.14" + --node-pool=pool-1 + + Upgrade the node pool pool-1 of sample-cluster to Kubernetes version + 1.14.7-gke.14: + + $ gcloud beta container clusters upgrade sample-cluster \ + --node-pool=pool-1 --cluster-version="1.14.7-gke.14" Upgrade the master of sample-cluster to the default cluster version: @@ -55,10 +57,11 @@ FLAGS complete. --cluster-version=CLUSTER_VERSION - The Kubernetes release version to which to upgrade the cluster's nodes. + The GKE release version to which to upgrade the cluster's node pools or + master. - If desired cluster version is omitted, node upgrades default to the - current master version and master upgrades default to the default + If desired cluster version is omitted, node pool upgrades default to + the current master version and master upgrades default to the default cluster version, which can be found in the server config. You can find the list of allowed versions for upgrades by running: @@ -81,8 +84,7 @@ FLAGS $ gcloud container get-server-config --master - Upgrade the cluster's master to the latest version of Kubernetes - supported on Kubernetes Engine. Nodes cannot be upgraded at the same + Upgrade the cluster's master. Node pools cannot be upgraded at the same time as the master. --node-pool=NODE_POOL diff --git a/gcloud/beta/dataproc/clusters/create b/gcloud/beta/dataproc/clusters/create index 8fa3d78d1..0f0fe6400 100644 --- a/gcloud/beta/dataproc/clusters/create +++ b/gcloud/beta/dataproc/clusters/create @@ -5,7 +5,14 @@ SYNOPSIS gcloud beta dataproc clusters create (CLUSTER : --region=REGION) --autoscaling-policy=AUTOSCALING_POLICY [--no-address] [--async] [--bucket=BUCKET] [--dataproc-metastore=DATAPROC_METASTORE] - [--enable-component-gateway] + [--driver-pool-accelerator=[type=TYPE,[count=COUNT],...]] + [--driver-pool-boot-disk-size=DRIVER_POOL_BOOT_DISK_SIZE] + [--driver-pool-boot-disk-type=DRIVER_POOL_BOOT_DISK_TYPE] + [--driver-pool-id=DRIVER_POOL_ID] + [--driver-pool-local-ssd-interface=DRIVER_POOL_LOCAL_SSD_INTERFACE] + [--driver-pool-machine-type=DRIVER_POOL_MACHINE_TYPE] + [--driver-pool-min-cpu-platform=PLATFORM] + [--driver-pool-size=DRIVER_POOL_SIZE] [--enable-component-gateway] [--initialization-action-timeout=TIMEOUT; default="10m"] [--initialization-actions=CLOUD_STORAGE_URI,[...]] [--labels=[KEY=VALUE,...]] @@ -16,6 +23,7 @@ SYNOPSIS [--master-machine-type=MASTER_MACHINE_TYPE] [--master-min-cpu-platform=PLATFORM] [--max-idle=MAX_IDLE] [--node-group=NODE_GROUP] + [--num-driver-pool-local-ssds=NUM_DRIVER_POOL_LOCAL_SSDS] [--num-master-local-ssds=NUM_MASTER_LOCAL_SSDS] [--num-masters=NUM_MASTERS] [--num-secondary-worker-local-ssds=NUM_SECONDARY_WORKER_LOCAL_SSDS] @@ -124,6 +132,55 @@ FLAGS external metastore in the format: "projects/{project-id}/locations/{region}/services/{service-name}". + --driver-pool-accelerator=[type=TYPE,[count=COUNT],...] + Attaches accelerators, such as GPUs, to the driver-pool instance(s). + + type + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. + + count + The number of accelerators to attach to each instance. The default + value is 1. + + --driver-pool-boot-disk-size=DRIVER_POOL_BOOT_DISK_SIZE + The size of the boot disk. The value must be a whole number followed by + a size unit of KB for kilobyte, MB for megabyte, GB for gigabyte, or TB + for terabyte. For example, 10GB will produce a 10 gigabyte disk. The + minimum size a boot disk can have is 10 GB. Disk size must be a + multiple of 1 GB. + + --driver-pool-boot-disk-type=DRIVER_POOL_BOOT_DISK_TYPE + The type of the boot disk. The value must be pd-balanced, pd-ssd, or + pd-standard. + + --driver-pool-id=DRIVER_POOL_ID + Custom identifier for the DRIVER Node Group being created. If not + provided, a random string is generated. + + --driver-pool-local-ssd-interface=DRIVER_POOL_LOCAL_SSD_INTERFACE + Interface to use to attach local SSDs to cluster driver pool node(s). + + --driver-pool-machine-type=DRIVER_POOL_MACHINE_TYPE + The type of machine to use for the cluster driver pool nodes. Defaults + to server-specified. + + --driver-pool-min-cpu-platform=PLATFORM + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: + + $ gcloud compute zones describe ZONE + + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). + + --driver-pool-size=DRIVER_POOL_SIZE + The size of the cluster driver pool. + --enable-component-gateway Enable access to the web UIs of selected components on the cluster through the component gateway. @@ -145,17 +202,16 @@ FLAGS numbers. --master-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the master instance(s). + Attaches accelerators, such as GPUs, to the master instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --master-boot-disk-size=MASTER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -176,18 +232,16 @@ FLAGS server-specified. --master-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --max-idle=MAX_IDLE The duration before cluster is auto-deleted after last job completes, @@ -199,6 +253,9 @@ FLAGS a short name ("node-group-name") or in the format "projects/{project-id}/zones/{zone}/nodeGroups/{node-group-name}". + --num-driver-pool-local-ssds=NUM_DRIVER_POOL_LOCAL_SSDS + The number of local SSDs to attach to each cluster driver pool node. + --num-master-local-ssds=NUM_MASTER_LOCAL_SSDS The number of local SSDs to attach to the master in a cluster. @@ -264,17 +321,17 @@ FLAGS for more information. --secondary-worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the secondary-worker instance(s). + Attaches accelerators, such as GPUs, to the secondary-worker + instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --secondary-worker-boot-disk-size=SECONDARY_WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -312,17 +369,16 @@ FLAGS cluster and jobs data, such as Spark and MapReduce history files. --worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the worker instance(s). + Attaches accelerators, such as GPUs, to the worker instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --worker-boot-disk-size=WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -342,18 +398,16 @@ FLAGS The type of machine to use for workers. Defaults to server-specified. --worker-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --zone=ZONE, -z ZONE The compute zone (e.g. us-central1-a) for the cluster. If empty and diff --git a/gcloud/beta/dataproc/help b/gcloud/beta/dataproc/help index 6a5adb545..9245fa33a 100644 --- a/gcloud/beta/dataproc/help +++ b/gcloud/beta/dataproc/help @@ -46,6 +46,9 @@ GROUPS jobs (BETA) Submit and manage Dataproc jobs. + node-groups + (BETA) Manage Dataproc node groups. + operations (BETA) View and manage Dataproc operations. diff --git a/gcloud/beta/dataproc/node-groups/describe b/gcloud/beta/dataproc/node-groups/describe new file mode 100644 index 000000000..91cd609d2 --- /dev/null +++ b/gcloud/beta/dataproc/node-groups/describe @@ -0,0 +1,69 @@ +NAME + gcloud beta dataproc node-groups describe - describe the node group + +SYNOPSIS + gcloud beta dataproc node-groups describe + (NODE_GROUP : --cluster=CLUSTER --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe the node group. + +EXAMPLES + To describe a node group, run: + + $ gcloud beta dataproc node-groups describe my-node-group-id \ + --region=us-central1 --cluster=my-cluster-name + +POSITIONAL ARGUMENTS + Node group resource - ID of the node group to describe. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument node_group on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + NODE_GROUP + ID of the node_group or fully qualified identifier for the + node_group. To set the node_group attribute: + ▸ provide the argument node_group on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The Cluster name. To set the cluster attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + Dataproc region for the node_group. Each Dataproc region constitutes + an independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud dataproc node-groups describe + + $ gcloud alpha dataproc node-groups describe + diff --git a/gcloud/beta/dataproc/node-groups/help b/gcloud/beta/dataproc/node-groups/help new file mode 100644 index 000000000..f3a89b4c4 --- /dev/null +++ b/gcloud/beta/dataproc/node-groups/help @@ -0,0 +1,43 @@ +NAME + gcloud beta dataproc node-groups - manage Dataproc node groups + +SYNOPSIS + gcloud beta dataproc node-groups COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage and modify Dataproc node groups created with a parent + cluster. + +EXAMPLES + To describe a node group: + + $ gcloud beta dataproc node-groups describe NODE_GROUP_ID \ + --cluster cluster_name --region region + + To resize a node group: + + $ gcloud beta dataproc node-groups resize NODE_GROUP_ID \ + --cluster cluster_name --region region --size new_size + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (BETA) Describe the node group. + + resize + (BETA) Resize the number of nodes in the node group. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud dataproc node-groups + + $ gcloud alpha dataproc node-groups + diff --git a/gcloud/beta/dataproc/node-groups/resize b/gcloud/beta/dataproc/node-groups/resize new file mode 100644 index 000000000..9febf37c8 --- /dev/null +++ b/gcloud/beta/dataproc/node-groups/resize @@ -0,0 +1,80 @@ +NAME + gcloud beta dataproc node-groups resize - resize the number of nodes in the + node group + +SYNOPSIS + gcloud beta dataproc node-groups resize + (NODE_GROUP : --cluster=CLUSTER --region=REGION) --size=SIZE + [--graceful-decommission-timeout=GRACEFUL_DECOMMISSION_TIMEOUT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Resize the number of nodes in the node group. + +EXAMPLES + To resize a node group, run: + + $ gcloud beta dataproc node-groups resize my-node-group-id \ + --region=us-central1 --cluster=my-cluster-name --size=5 + +POSITIONAL ARGUMENTS + Node group resource - ID of the node group to resize. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument node_group on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + NODE_GROUP + ID of the node_group or fully qualified identifier for the + node_group. To set the node_group attribute: + ▸ provide the argument node_group on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The Cluster name. To set the cluster attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + Dataproc region for the node_group. Each Dataproc region constitutes + an independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +REQUIRED FLAGS + --size=SIZE + New size for a node group. + +OPTIONAL FLAGS + --graceful-decommission-timeout=GRACEFUL_DECOMMISSION_TIMEOUT + Graceful decommission timeout for a node group scale-down resize. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud dataproc node-groups resize + + $ gcloud alpha dataproc node-groups resize + diff --git a/gcloud/beta/dataproc/workflow-templates/set-managed-cluster b/gcloud/beta/dataproc/workflow-templates/set-managed-cluster index d3513f337..2a0d402ee 100644 --- a/gcloud/beta/dataproc/workflow-templates/set-managed-cluster +++ b/gcloud/beta/dataproc/workflow-templates/set-managed-cluster @@ -141,17 +141,16 @@ FLAGS numbers. --master-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the master instance(s). + Attaches accelerators, such as GPUs, to the master instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --master-boot-disk-size=MASTER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -172,18 +171,16 @@ FLAGS server-specified. --master-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --node-group=NODE_GROUP The name of the sole-tenant node group to create the cluster on. Can be @@ -255,17 +252,17 @@ FLAGS for more information. --secondary-worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the secondary-worker instance(s). + Attaches accelerators, such as GPUs, to the secondary-worker + instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --secondary-worker-boot-disk-size=SECONDARY_WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -303,17 +300,16 @@ FLAGS cluster and jobs data, such as Spark and MapReduce history files. --worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the worker instance(s). + Attaches accelerators, such as GPUs, to the worker instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --worker-boot-disk-size=WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -333,18 +329,16 @@ FLAGS The type of machine to use for workers. Defaults to server-specified. --worker-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --zone=ZONE, -z ZONE The compute zone (e.g. us-central1-a) for the cluster. If empty and diff --git a/gcloud/beta/firestore/export b/gcloud/beta/firestore/export index b6181b753..1884da343 100644 --- a/gcloud/beta/firestore/export +++ b/gcloud/beta/firestore/export @@ -46,11 +46,10 @@ FLAGS complete. --collection-ids=[COLLECTION_IDS,...] - A list specifying which collections will be included in the operation. + List specifying which collections will be included in the operation. When omitted, all collections are included. - For example, to operate on only the 'customers' and 'orders' - collections: + For example, to operate on only the customers and orders collections: $ gcloud beta firestore export --collection-ids='customers','orders' @@ -62,13 +61,12 @@ FLAGS $ gcloud beta firestore export --database='foo' --namespace-ids=[NAMESPACE_IDS,...] - A list specifying which namespaces will be included in the operation. + List specifying which namespaces will be included in the operation. When omitted, all namespaces are included. This is only supported for Datastore Mode databases. - For example, to operate on only the 'customers' and 'orders' - namespaces: + For example, to operate on only the customers and orders namespaces: $ gcloud beta firestore export --namespaces-ids='customers','orders' diff --git a/gcloud/beta/firestore/import b/gcloud/beta/firestore/import index 3764969bb..448b5f969 100644 --- a/gcloud/beta/firestore/import +++ b/gcloud/beta/firestore/import @@ -41,11 +41,10 @@ FLAGS complete. --collection-ids=[COLLECTION_IDS,...] - A list specifying which collections will be included in the operation. + List specifying which collections will be included in the operation. When omitted, all collections are included. - For example, to operate on only the 'customers' and 'orders' - collections: + For example, to operate on only the customers and orders collections: $ gcloud beta firestore import --collection-ids='customers','orders' @@ -57,13 +56,12 @@ FLAGS $ gcloud beta firestore import --database='foo' --namespace-ids=[NAMESPACE_IDS,...] - A list specifying which namespaces will be included in the operation. + List specifying which namespaces will be included in the operation. When omitted, all namespaces are included. This is only supported for Datastore Mode databases. - For example, to operate on only the 'customers' and 'orders' - namespaces: + For example, to operate on only the customers and orders namespaces: $ gcloud beta firestore import --namespaces-ids='customers','orders' diff --git a/gcloud/beta/firestore/operations/cancel b/gcloud/beta/firestore/operations/cancel index c84095ccf..dcf1ebc96 100644 --- a/gcloud/beta/firestore/operations/cancel +++ b/gcloud/beta/firestore/operations/cancel @@ -3,7 +3,8 @@ NAME Firestore admin operation SYNOPSIS - gcloud beta firestore operations cancel NAME [GCLOUD_WIDE_FLAG ...] + gcloud beta firestore operations cancel NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Cancel a currently-running Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud beta firestore operations cancel --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/firestore/operations/delete b/gcloud/beta/firestore/operations/delete index 3cea2ba36..87ecdc730 100644 --- a/gcloud/beta/firestore/operations/delete +++ b/gcloud/beta/firestore/operations/delete @@ -3,7 +3,8 @@ NAME Firestore admin operation SYNOPSIS - gcloud beta firestore operations delete NAME [GCLOUD_WIDE_FLAG ...] + gcloud beta firestore operations delete NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Delete a completed Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud beta firestore operations delete --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/firestore/operations/describe b/gcloud/beta/firestore/operations/describe index 75d7ecd40..567430525 100644 --- a/gcloud/beta/firestore/operations/describe +++ b/gcloud/beta/firestore/operations/describe @@ -3,7 +3,8 @@ NAME Cloud Firestore admin operation SYNOPSIS - gcloud beta firestore operations describe NAME [GCLOUD_WIDE_FLAG ...] + gcloud beta firestore operations describe NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Retrieves information about a Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud beta firestore operations describe --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/firestore/operations/list b/gcloud/beta/firestore/operations/list index 3b5b09959..401ce1799 100644 --- a/gcloud/beta/firestore/operations/list +++ b/gcloud/beta/firestore/operations/list @@ -3,7 +3,8 @@ NAME operations and their status SYNOPSIS - gcloud beta firestore operations list [--filter=EXPRESSION] + gcloud beta firestore operations list + [--database=DATABASE; default="(default)"] [--filter=EXPRESSION] [--limit=LIMIT; default=100] [--page-size=PAGE_SIZE; default=100] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -24,6 +25,14 @@ EXAMPLES $ gcloud beta firestore operations list --filter="done:true" +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud beta firestore operations list --database='foo' + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/beta/pubsub/schemas/commit b/gcloud/beta/pubsub/schemas/commit new file mode 100644 index 000000000..775ca5504 --- /dev/null +++ b/gcloud/beta/pubsub/schemas/commit @@ -0,0 +1,71 @@ +NAME + gcloud beta pubsub schemas commit - commit a Pub/Sub schema revision + +SYNOPSIS + gcloud beta pubsub schemas commit SCHEMA --type=TYPE + (--definition=DEFINITION | --definition-file=DEFINITION_FILE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Commit a Pub/Sub schema revision. + +EXAMPLES + To commit a PROTOCOL_BUFFER schema revision called "key-schema" that + requires exactly one-string field named "key", run: + + $ gcloud beta pubsub schemas commit key-schema \ + --definition="syntax = 'proto3'; message Message { optional \ + string key = 1; }" --type=protocol-buffer To commit an equivalent \ + AVRO schema revision, run: + + $ gcloud beta pubsub schemas commit key-schema \ + --definition="{ 'type': 'record', 'namespace': 'my.ns', 'name': \ + 'KeyMsg', 'fields': [ { 'name': 'key', 'type': 'string' } ] }" \ + --type=avro + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema to revise. 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +REQUIRED FLAGS + --type=TYPE + The type of the schema. + + Schema definition + + Exactly one of these must be specified: + + --definition=DEFINITION + The new definition of the schema. + + --definition-file=DEFINITION_FILE + File containing the new schema definition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-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 pubsub schemas commit + + $ gcloud alpha pubsub schemas commit + diff --git a/gcloud/beta/pubsub/schemas/delete-revision b/gcloud/beta/pubsub/schemas/delete-revision new file mode 100644 index 000000000..32ed4785c --- /dev/null +++ b/gcloud/beta/pubsub/schemas/delete-revision @@ -0,0 +1,48 @@ +NAME + gcloud beta pubsub schemas delete-revision - delete a Pub/Sub schema + revision + +SYNOPSIS + gcloud beta pubsub schemas delete-revision SCHEMA [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Pub/Sub schema revision. + +EXAMPLES + To roll back to an existing schema revision called "key-schema" with + revision_id: "0a0b0c0d", run: + + $ gcloud beta pubsub schemas delete-revision key-schema@0a0b0c0d + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema revision to delete. This represents a + Cloud resource. (NOTE) Some attributes are not given arguments in this + group but can be set in other ways. To set the project attribute: + ◆ provide the argument schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema 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 beta and might change without notice. These + variants are also available: + + $ gcloud pubsub schemas delete-revision + + $ gcloud alpha pubsub schemas delete-revision + diff --git a/gcloud/beta/pubsub/schemas/help b/gcloud/beta/pubsub/schemas/help index ff95e6dcf..97cac5df4 100644 --- a/gcloud/beta/pubsub/schemas/help +++ b/gcloud/beta/pubsub/schemas/help @@ -18,18 +18,30 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + commit + (BETA) Commit a Pub/Sub schema revision. + create (BETA) Create a Pub/Sub schema. delete (BETA) Delete a Pub/Sub schema. + delete-revision + (BETA) Delete a Pub/Sub schema revision. + describe (BETA) Show details of a Pub/Sub schema. list (BETA) List Pub/Sub schemas. + list-revisions + (BETA) List revisions of a Pub/Sub schema. + + rollback + (BETA) Roll back a Pub/Sub schema to a specified revision. + validate-message (BETA) Validate a message against a Pub/Sub schema. diff --git a/gcloud/beta/pubsub/schemas/list-revisions b/gcloud/beta/pubsub/schemas/list-revisions new file mode 100644 index 000000000..671a81f46 --- /dev/null +++ b/gcloud/beta/pubsub/schemas/list-revisions @@ -0,0 +1,98 @@ +NAME + gcloud beta pubsub schemas list-revisions - list revisions of a Pub/Sub + schema + +SYNOPSIS + gcloud beta pubsub schemas list-revisions SCHEMA + [--view=VIEW; default="basic"] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List revisions of a Pub/Sub schema. + +EXAMPLES + To list the revisions for a schema, run: + + $ gcloud beta pubsub schemas list-revisions my-schema + +POSITIONAL ARGUMENTS + Schema resource - Parent Pub/Sub schema to list all contained revisions. + 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +FLAGS + --view=VIEW; default="basic" + There are two possible views, 'basic' and 'full', default is 'basic'. + VIEW must be one of: + + basic + Include the name and type of the schema, but not the definition. + + full + Include all Schema object fields. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the pubsub/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/pubsub/docs + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud pubsub schemas list-revisions + + $ gcloud alpha pubsub schemas list-revisions + diff --git a/gcloud/beta/pubsub/schemas/rollback b/gcloud/beta/pubsub/schemas/rollback new file mode 100644 index 000000000..5a977ec59 --- /dev/null +++ b/gcloud/beta/pubsub/schemas/rollback @@ -0,0 +1,54 @@ +NAME + gcloud beta pubsub schemas rollback - roll back a Pub/Sub schema to a + specified revision + +SYNOPSIS + gcloud beta pubsub schemas rollback SCHEMA --revision-id=REVISION_ID + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Roll back a Pub/Sub schema to a specified revision. + +EXAMPLES + To roll back to an existing schema revision called "key-schema" with + revision_id: "0a0b0c0d", run: + + $ gcloud beta pubsub schemas rollback key-schema \ + --revision-id=0a0b0c0d + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema to rollback. 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +REQUIRED FLAGS + --revision-id=REVISION_ID + The revision to roll back to. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud pubsub schemas rollback + + $ gcloud alpha pubsub schemas rollback + diff --git a/gcloud/beta/pubsub/topics/create b/gcloud/beta/pubsub/topics/create index b07dcf380..0a06dee18 100644 --- a/gcloud/beta/pubsub/topics/create +++ b/gcloud/beta/pubsub/topics/create @@ -7,7 +7,9 @@ SYNOPSIS [--message-retention-duration=MESSAGE_RETENTION_DURATION] [--message-storage-policy-allowed-regions=[REGION,...]] [--message-encoding=ENCODING (--schema=SCHEMA - : --schema-project=SCHEMA_PROJECT)] + : --schema-project=SCHEMA_PROJECT) + : --first-revision-id=FIRST_REVISION_ID + --last-revision-id=LAST_REVISION_ID] [--topic-encryption-key=TOPIC_ENCRYPTION_KEY : --topic-encryption-key-keyring=TOPIC_ENCRYPTION_KEY_KEYRING --topic-encryption-key-location=TOPIC_ENCRYPTION_KEY_LOCATION @@ -73,6 +75,12 @@ FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --first-revision-id=FIRST_REVISION_ID + The id of the oldest revision allowed for the specified schema. + + --last-revision-id=LAST_REVISION_ID + The id of the most recent revision allowed for the specified schema + Schema resource - Name of the schema that messages published to this topic must conform to. The arguments in this group can be used to specify the attributes of this resource. diff --git a/gcloud/beta/pubsub/topics/update b/gcloud/beta/pubsub/topics/update index e4e6dca3a..8852f4db5 100644 --- a/gcloud/beta/pubsub/topics/update +++ b/gcloud/beta/pubsub/topics/update @@ -6,6 +6,11 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [--clear-message-retention-duration | --message-retention-duration=MESSAGE_RETENTION_DURATION] + [--clear-schema-settings + | [--message-encoding=ENCODING (--schema=SCHEMA + : --schema-project=SCHEMA_PROJECT) + : --first-revision-id=FIRST_REVISION_ID + --last-revision-id=LAST_REVISION_ID]] [--message-storage-policy-allowed-regions=[REGION,...] | --recompute-message-storage-policy] [--topic-encryption-key=TOPIC_ENCRYPTION_KEY @@ -124,6 +129,50 @@ FLAGS seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. + At most one of these can be specified: + + --clear-schema-settings + If set, clear the Schema Settings from the topic. + + Schema settings. The schema that messages published to this topic must + conform to and the expected message encoding. + + --message-encoding=ENCODING + The encoding of messages validated against the schema. ENCODING + must be one of: json, binary. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --first-revision-id=FIRST_REVISION_ID + The id of the oldest revision allowed for the specified schema. + + --last-revision-id=LAST_REVISION_ID + The id of the most recent revision allowed for the specified schema + + Schema resource - Name of the schema that messages published to this + topic must conform to. The arguments in this group can be used to + specify the attributes of this resource. + + This must be specified. + + --schema=SCHEMA + ID of the schema or fully qualified identifier for the schema. To + set the schema attribute: + ◇ provide the argument --schema on the command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --schema-project=SCHEMA_PROJECT + Project ID of the Google Cloud project for the schema. To set the + project attribute: + ◇ provide the argument --schema on the command line with a + fully specified name; + ◇ provide the argument --schema-project on the command line; + ◇ provide the argument --project on the command line; + ◇ set the property core/project. + Message storage policy options. At most one of these can be specified: diff --git a/gcloud/beta/recommender/recommendations/help b/gcloud/beta/recommender/recommendations/help index 09fd4b009..683959eb2 100644 --- a/gcloud/beta/recommender/recommendations/help +++ b/gcloud/beta/recommender/recommendations/help @@ -25,6 +25,9 @@ COMMANDS mark-claimed (BETA) Mark a recommendation's state as CLAIMED. + mark-dismissed + (BETA) Mark recommendation's state as DISMISSED. + mark-failed (BETA) Mark a recommendation's state as FAILED. diff --git a/gcloud/beta/recommender/recommendations/mark-dismissed b/gcloud/beta/recommender/recommendations/mark-dismissed new file mode 100644 index 000000000..d8e6d2dbc --- /dev/null +++ b/gcloud/beta/recommender/recommendations/mark-dismissed @@ -0,0 +1,75 @@ +NAME + gcloud beta recommender recommendations mark-dismissed - mark + recommendation's state as DISMISSED + +SYNOPSIS + gcloud beta recommender recommendations mark-dismissed RECOMMENDATION + --etag=ETAG --location=LOCATION --recommender=RECOMMENDER + (--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID + | --organization=ORGANIZATION_ID | --project=PROJECT_ID) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Mark recommendation's state as DISMISSED. Can be applied to + recommendations in ACTIVE state. The following parent resources are + supported: project, billing account, folder, and organization as parent + resources for recommendations. + +EXAMPLES + To mark a recommendation as DISMISSED: + + $ gcloud beta recommender recommendations mark-dismissed abcd-1234 \ + --project=project-name --location=global \ + --recommender=google.compute.instance.MachineTypeRecommender \ + --etag=abc123 + +POSITIONAL ARGUMENTS + RECOMMENDATION + Recommendation ID which will be marked as dismissed + +REQUIRED FLAGS + --etag=ETAG + Etag of a recommendation + + --location=LOCATION + Location + + --recommender=RECOMMENDER + Recommender of the recommendations + + Resource that is associated with cloud entity type. Currently four + mutually exclusive flags are supported, --project, --billing-account, + --folder, --organization. + + Exactly one of these must be specified: + + --billing-account=BILLING_ACCOUNT + The Google Cloud Platform billing account ID to use for this + invocation. + + --folder=FOLDER_ID + The Google Cloud Platform folder ID to use for this invocation. + + --organization=ORGANIZATION_ID + The Google Cloud Platform organization ID to use for this invocation. + + --project=PROJECT_ID + The Google Cloud Platform project ID. Overrides the default + core/project property value for this command invocation. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud recommender recommendations mark-dismissed + + $ gcloud alpha recommender recommendations mark-dismissed + diff --git a/gcloud/beta/resource-config/bulk-export b/gcloud/beta/resource-config/bulk-export index 414e57b46..36529395e 100644 --- a/gcloud/beta/resource-config/bulk-export +++ b/gcloud/beta/resource-config/bulk-export @@ -5,9 +5,9 @@ NAME SYNOPSIS gcloud beta resource-config bulk-export [--on-error=ON_ERROR; default="ignore"] [--path=PATH; default="-"] - [--resource-format=RESOURCE_FORMAT] [--storage-path=STORAGE_PATH] + [--resource-format=RESOURCE_FORMAT] [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] - [--resource-types=[RESOURCE_TYPE,...] + [--storage-path=STORAGE_PATH | --resource-types=[RESOURCE_TYPE,...] | --resource-types-file=RESOURCE_TYPE_FILE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -67,9 +67,8 @@ FLAGS Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. - --storage-path=STORAGE_PATH - Google Cloud Storage path where a Cloud Asset Inventory export will be - stored, example: gs://your-bucket-name/your/prefix/path + RESOURCE PARENT FLAG - specify one of the following to determine the scope + of exported resources. At most one of these can be specified: @@ -82,22 +81,35 @@ FLAGS --project=PROJECT Project ID + Select storage-path if you want to specify the Google Cloud Storage bucket + bulk-export should use for Cloud Asset Inventory Export. Alternatively, + you can provide a RESOURCE TYPE FILTER to filter resources. Filtering + resources does not use Google Cloud Storage to export resources. + At most one of these can be specified: - --resource-types=[RESOURCE_TYPE,...] - List of Config Connector KRM Kinds to export. For a full list of - supported resource types for a given parent scope run: + --storage-path=STORAGE_PATH + Google Cloud Storage path where a Cloud Asset Inventory export will + be stored, example: gs://your-bucket-name/your/prefix/path - $ gcloud beta resource-config list-resource-types \ - --[project|organization|folder]= + RESOURCE TYPE FILTERS - specify resource types to export. - --resource-types-file=RESOURCE_TYPE_FILE - A comma (',') or newline ('\n') separated file containing the list of - Config Connector KRM Kinds to export. For a full list of supported - resource types for a given parent scope run: + At most one of these can be specified: - $ gcloud beta resource-config list-resource-types \ - --[project|organization|folder]= + --resource-types=[RESOURCE_TYPE,...] + List of Config Connector KRM Kinds to export. For a full list of + supported resource types for a given parent scope run: + + $ gcloud beta resource-config list-resource-types \ + --[project|organization|folder]= + + --resource-types-file=RESOURCE_TYPE_FILE + A comma (',') or newline ('\n') separated file containing the list + of Config Connector KRM Kinds to export. For a full list of + supported resource types for a given parent scope run: + + $ gcloud beta resource-config list-resource-types \ + --[project|organization|folder]= GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/resource-config/list-resource-types b/gcloud/beta/resource-config/list-resource-types index a279ed5d6..997a4fcf4 100644 --- a/gcloud/beta/resource-config/list-resource-types +++ b/gcloud/beta/resource-config/list-resource-types @@ -26,6 +26,9 @@ EXAMPLES --project=my-project FLAGS + RESOURCE PARENT FLAG - specify one of the following to determine the scope + of exported resources. + At most one of these can be specified: --folder=FOLDER diff --git a/gcloud/beta/sql/users/create b/gcloud/beta/sql/users/create index fcfe0e463..9e905a7b2 100644 --- a/gcloud/beta/sql/users/create +++ b/gcloud/beta/sql/users/create @@ -28,13 +28,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). --password=PASSWORD Cloud SQL user's password. diff --git a/gcloud/beta/sql/users/delete b/gcloud/beta/sql/users/delete index 6d9f3cfc8..225bd1c2d 100644 --- a/gcloud/beta/sql/users/delete +++ b/gcloud/beta/sql/users/delete @@ -23,13 +23,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/sql/users/describe b/gcloud/beta/sql/users/describe new file mode 100644 index 000000000..702d460c3 --- /dev/null +++ b/gcloud/beta/sql/users/describe @@ -0,0 +1,50 @@ +NAME + gcloud beta sql users describe - retrieves information about a Cloud SQL + user in a given instance + +SYNOPSIS + gcloud beta sql users describe USERNAME --instance=INSTANCE, -i INSTANCE + [--host=HOST] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Retrieves information about a Cloud SQL user in a given instance. + +EXAMPLES + To fetch a user with name 'my-user' and optional host '%' in instance + 'my-instance', run: + + $ gcloud beta sql users describe my-user --host=% \ + --instance=my-instance + +POSITIONAL ARGUMENTS + USERNAME + Cloud SQL username. + +REQUIRED FLAGS + --instance=INSTANCE, -i INSTANCE + Cloud SQL instance ID. + +OPTIONAL FLAGS + --host=HOST + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha sql users describe + diff --git a/gcloud/beta/sql/users/help b/gcloud/beta/sql/users/help index 3a5ecbcd3..91724230e 100644 --- a/gcloud/beta/sql/users/help +++ b/gcloud/beta/sql/users/help @@ -22,6 +22,10 @@ COMMANDS delete (BETA) Deletes a Cloud SQL user in a given instance. + describe + (BETA) Retrieves information about a Cloud SQL user in a given + instance. + list (BETA) Lists Cloud SQL users in a given instance. diff --git a/gcloud/beta/sql/users/set-password b/gcloud/beta/sql/users/set-password index 4dd800d4a..34cf5ea94 100644 --- a/gcloud/beta/sql/users/set-password +++ b/gcloud/beta/sql/users/set-password @@ -26,13 +26,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). At most one of these can be specified: diff --git a/gcloud/beta/sql/users/set-password-policy b/gcloud/beta/sql/users/set-password-policy index 749f42b96..aee6b6a1f 100644 --- a/gcloud/beta/sql/users/set-password-policy +++ b/gcloud/beta/sql/users/set-password-policy @@ -47,13 +47,13 @@ OPTIONAL FLAGS Postgres. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). --password-policy-allowed-failed-attempts=PASSWORD_POLICY_ALLOWED_FAILED_ATTEMPTS Number of failed login attempts allowed before a user is locked out. diff --git a/gcloud/builds/worker-pools/create b/gcloud/builds/worker-pools/create index 65d545efd..61344fe72 100644 --- a/gcloud/builds/worker-pools/create +++ b/gcloud/builds/worker-pools/create @@ -59,15 +59,15 @@ OPTIONAL FLAGS --peered-network-ip-range=PEERED_NETWORK_IP_RANGE An IP range for your peered network. Specify the IP range using Classless Inter-Domain Routing (CIDR) notation with a slash and the - subnet prefix size, such as '/29'. + subnet prefix size, such as /29. Your subnet prefix size must be between 1 and 29. Optional: you can specify an IP address before the subnet prefix value - for example - 192.168.0.1/24. + 192.168.0.0/24. If no IP address is specified, your VPC automatically determines the starting IP for the range. If no IP range is specified, Cloud - Build uses '/24' as the default network IP range. + Build uses /24 as the default network IP range. --no-public-egress If set, workers in the worker pool are created without an external diff --git a/gcloud/compute/instance-groups/managed/create b/gcloud/compute/instance-groups/managed/create index 091ff9a07..106a9506b 100644 --- a/gcloud/compute/instance-groups/managed/create +++ b/gcloud/compute/instance-groups/managed/create @@ -13,7 +13,12 @@ SYNOPSIS [--zones=ZONE,[ZONE,...]] [--health-check=HEALTH_CHECK | --http-health-check=HTTP_HEALTH_CHECK | --https-health-check=HTTPS_HEALTH_CHECK] - [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--region=REGION | --zone=ZONE] + [--update-policy-max-surge=MAX_SURGE + --update-policy-max-unavailable=MAX_UNAVAILABLE + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD --update-policy-type=UPDATE_TYPE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud compute instance-groups managed create creates a Compute Engine @@ -187,6 +192,92 @@ OPTIONAL FLAGS Overrides the default compute/zone property value for this command invocation. + Parameters for setting update policy for this managed instance group. + + --update-policy-max-surge=MAX_SURGE + Maximum additional number of VMs that can be created during the + update process. This can be a fixed number (e.g. 5) or a percentage + of size to the managed instance group (e.g. 10%). Defaults to 0 if + the managed instance group has stateful configuration, or to the + number of zones in which it operates otherwise. + + --update-policy-max-unavailable=MAX_UNAVAILABLE + Maximum number of VMs that can be unavailable during the update + process. This can be a fixed number (e.g. 5) or a percentage of size + to the managed instance group (e.g. 10%). Defaults to the number of + zones in which the managed instance group operates. + + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + Use this flag to minimize disruption as much as possible or to apply + a more disruptive action than is strictly necessary. The MIG performs + at least this action on each VM while updating. If the update + requires a more disruptive action than the one specified here, then + the more disruptive action is performed. UPDATE_POLICY_MINIMAL_ACTION + must be one of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION + Use this flag to prevent an update if it requires more disruption + than you can afford. At most, the MIG performs the specified action + on each VM while updating. If the update requires a more disruptive + action than the one specified here, then the update fails and no + changes are made. UPDATE_POLICY_MOST_DISRUPTIVE_ACTION must be one + of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD + Type of replacement method. Specifies what action will be taken to + update VMs. Defaults to ``recreate`` if the managed instance group + has stateful configuration, or to ``substitute`` otherwise. + UPDATE_POLICY_REPLACEMENT_METHOD must be one of: + + recreate + Recreate VMs and preserve the VM names. The VM IDs and creation + timestamps might change. + substitute + Delete old VMs and create VMs with new names. + + --update-policy-type=UPDATE_TYPE + Specifies the type of update process. You can specify either + ``proactive`` so that the managed instance group proactively executes + actions in order to bring VMs to their target versions or + ``opportunistic`` so that no action is proactively executed but the + update will be performed as part of other actions. UPDATE_TYPE must + be one of: + + opportunistic + Do not proactively replace VMs. Create new VMs and delete old + ones on resizes of the group and when you target specific VMs to + be updated or recreated. + proactive + Replace VMs proactively. + 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/instance-groups/managed/instance-configs/create b/gcloud/compute/instance-groups/managed/instance-configs/create index bc4ad9a70..032e6de43 100644 --- a/gcloud/compute/instance-groups/managed/instance-configs/create +++ b/gcloud/compute/instance-groups/managed/instance-configs/create @@ -53,15 +53,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME],[mode=MODE],[source=SOURCE] Disks considered stateful by the instance group. Managed instance diff --git a/gcloud/compute/instance-groups/managed/instance-configs/delete b/gcloud/compute/instance-groups/managed/instance-configs/delete index 372c4db0c..1c184e3f1 100644 --- a/gcloud/compute/instance-groups/managed/instance-configs/delete +++ b/gcloud/compute/instance-groups/managed/instance-configs/delete @@ -45,15 +45,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --update-instance Apply the configuration changes immediately to the instance. If you diff --git a/gcloud/compute/instance-groups/managed/instance-configs/update b/gcloud/compute/instance-groups/managed/instance-configs/update index 5e41bbfbd..40aa600d0 100644 --- a/gcloud/compute/instance-groups/managed/instance-configs/update +++ b/gcloud/compute/instance-groups/managed/instance-configs/update @@ -60,15 +60,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --remove-stateful-disks=DEVICE_NAME,[DEVICE_NAME,...] Remove stateful configuration for the specified disks from the diff --git a/gcloud/compute/instance-groups/managed/rolling-action/replace b/gcloud/compute/instance-groups/managed/rolling-action/replace index f429a364b..3413a50b5 100644 --- a/gcloud/compute/instance-groups/managed/rolling-action/replace +++ b/gcloud/compute/instance-groups/managed/rolling-action/replace @@ -33,8 +33,8 @@ FLAGS --replacement-method=REPLACEMENT_METHOD Type of replacement method. Specifies what action will be taken to - update instances. Defaults to recreate if the managed instance group - has stateful configuration, or to substitute otherwise. + update instances. Defaults to ``recreate`` if the managed instance + group has stateful configuration, or to ``substitute`` otherwise. REPLACEMENT_METHOD must be one of: recreate diff --git a/gcloud/compute/instance-groups/managed/rolling-action/start-update b/gcloud/compute/instance-groups/managed/rolling-action/start-update index b31f9ab6b..2a1e578d9 100644 --- a/gcloud/compute/instance-groups/managed/rolling-action/start-update +++ b/gcloud/compute/instance-groups/managed/rolling-action/start-update @@ -37,8 +37,9 @@ COMMONLY USED FLAGS Desired update type. TYPE must be one of: opportunistic - Do not proactively replace instances. Create new instances and - delete old on resizes of the group. + Do not proactively replace VMs. Create new VMs and delete old ones + on resizes of the group and when you target specific VMs to be + updated or recreated. proactive Replace instances proactively. @@ -72,15 +73,15 @@ OTHER FLAGS MINIMAL_ACTION must be one of: refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --most-disruptive-allowed-action=MOST_DISRUPTIVE_ALLOWED_ACTION Use this flag to prevent an update if it requires more disruption than @@ -94,20 +95,20 @@ OTHER FLAGS MOST_DISRUPTIVE_ALLOWED_ACTION must be one of: refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --replacement-method=REPLACEMENT_METHOD Type of replacement method. Specifies what action will be taken to - update instances. Defaults to recreate if the managed instance group - has stateful configuration, or to substitute otherwise. + update instances. Defaults to ``recreate`` if the managed instance + group has stateful configuration, or to ``substitute`` otherwise. REPLACEMENT_METHOD must be one of: recreate diff --git a/gcloud/compute/instance-groups/managed/update b/gcloud/compute/instance-groups/managed/update index 9006983b4..73ced9dfd 100644 --- a/gcloud/compute/instance-groups/managed/update +++ b/gcloud/compute/instance-groups/managed/update @@ -13,14 +13,26 @@ SYNOPSIS | --initial-delay=INITIAL_DELAY --health-check=HEALTH_CHECK | --http-health-check=HTTP_HEALTH_CHECK | --https-health-check=HTTPS_HEALTH_CHECK] - [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--region=REGION | --zone=ZONE] + [--update-policy-max-surge=MAX_SURGE + --update-policy-max-unavailable=MAX_UNAVAILABLE + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD --update-policy-type=UPDATE_TYPE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Update a Compute Engine managed instance group. gcloud compute instance-groups managed update allows you to specify or - modify the stateful policy and autohealing policy for an existing managed - instance group. + modify the description and group policies for an existing managed instance + group, including the group's update policy and optional autohealing and + stateful policies + + The group's update policy defines how an updated VM configuration is + applied to existing VMs in the group. For more information, see [Applying + new configurations] + (https://cloud.google.com/compute/docs/instance-groups/updating-migs) to + VMs in a MIG. A stateful policy defines which resources should be preserved across the group. When instances in the group are recreated, stateful resources are @@ -180,6 +192,92 @@ FLAGS Overrides the default compute/zone property value for this command invocation. + Parameters for setting update policy for this managed instance group. + + --update-policy-max-surge=MAX_SURGE + Maximum additional number of VMs that can be created during the + update process. This can be a fixed number (e.g. 5) or a percentage + of size to the managed instance group (e.g. 10%). Defaults to 0 if + the managed instance group has stateful configuration, or to the + number of zones in which it operates otherwise. + + --update-policy-max-unavailable=MAX_UNAVAILABLE + Maximum number of VMs that can be unavailable during the update + process. This can be a fixed number (e.g. 5) or a percentage of size + to the managed instance group (e.g. 10%). Defaults to the number of + zones in which the managed instance group operates. + + --update-policy-minimal-action=UPDATE_POLICY_MINIMAL_ACTION + Use this flag to minimize disruption as much as possible or to apply + a more disruptive action than is strictly necessary. The MIG performs + at least this action on each VM while updating. If the update + requires a more disruptive action than the one specified here, then + the more disruptive action is performed. UPDATE_POLICY_MINIMAL_ACTION + must be one of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-most-disruptive-action=UPDATE_POLICY_MOST_DISRUPTIVE_ACTION + Use this flag to prevent an update if it requires more disruption + than you can afford. At most, the MIG performs the specified action + on each VM while updating. If the update requires a more disruptive + action than the one specified here, then the update fails and no + changes are made. UPDATE_POLICY_MOST_DISRUPTIVE_ACTION must be one + of: + + none + No action + refresh + Apply the new configuration without stopping VMs, if possible. + For example, use ``refresh`` to apply changes that only affect + metadata or additional disks. + restart + Apply the new configuration without replacing VMs, if possible. + For example, stopping VMs and starting them again is sufficient + to apply changes to machine type. + replace + Replace old VMs according to the + --update-policy-replacement-method flag. + + --update-policy-replacement-method=UPDATE_POLICY_REPLACEMENT_METHOD + Type of replacement method. Specifies what action will be taken to + update VMs. Defaults to ``recreate`` if the managed instance group + has stateful configuration, or to ``substitute`` otherwise. + UPDATE_POLICY_REPLACEMENT_METHOD must be one of: + + recreate + Recreate VMs and preserve the VM names. The VM IDs and creation + timestamps might change. + substitute + Delete old VMs and create VMs with new names. + + --update-policy-type=UPDATE_TYPE + Specifies the type of update process. You can specify either + ``proactive`` so that the managed instance group proactively executes + actions in order to bring VMs to their target versions or + ``opportunistic`` so that no action is proactively executed but the + update will be performed as part of other actions. UPDATE_TYPE must + be one of: + + opportunistic + Do not proactively replace VMs. Create new VMs and delete old + ones on resizes of the group and when you target specific VMs to + be updated or recreated. + proactive + Replace VMs proactively. + 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/instance-groups/managed/update-instances b/gcloud/compute/instance-groups/managed/update-instances index 1a2dbbd0e..ed0bfd53e 100644 --- a/gcloud/compute/instance-groups/managed/update-instances +++ b/gcloud/compute/instance-groups/managed/update-instances @@ -66,15 +66,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. --most-disruptive-allowed-action=MOST_DISRUPTIVE_ALLOWED_ACTION; default="replace" Use this flag to prevent an update if it requires more disruption than @@ -90,15 +90,15 @@ OPTIONAL FLAGS none No action refresh - Apply the new configuration without stopping instances, if - possible. For example, use refresh to apply changes that only - affect metadata or additional disks. + Apply the new configuration without stopping VMs, if possible. For + example, use ``refresh`` to apply changes that only affect metadata + or additional disks. restart - Apply the new configuration without replacing instances, if - possible. For example, stopping instances and starting them again - is sufficient to apply changes to machine type. + Apply the new configuration without replacing VMs, if possible. For + example, stopping VMs and starting them again is sufficient to + apply changes to machine type. replace - Replace old instances according to the --replacement-method flag. + Replace old VMs according to the --replacement-method flag. At most one of these can be specified: diff --git a/gcloud/compute/interconnects/attachments/dedicated/create b/gcloud/compute/interconnects/attachments/dedicated/create index 1753ab478..a2e3c7fa2 100644 --- a/gcloud/compute/interconnects/attachments/dedicated/create +++ b/gcloud/compute/interconnects/attachments/dedicated/create @@ -135,7 +135,7 @@ OPTIONAL FLAGS Only IPv4 protocol is enabled on this attachment. --vlan=VLAN - Desired VLAN for this attachment, in the range 2-4094. If not supplied, + Desired VLAN for this attachment, in the range 2-4093. If not supplied, Google will automatically select a VLAN. GCLOUD WIDE FLAGS diff --git a/gcloud/compute/reservations/create b/gcloud/compute/reservations/create index 0b470bda8..3a0992858 100644 --- a/gcloud/compute/reservations/create +++ b/gcloud/compute/reservations/create @@ -18,11 +18,21 @@ DESCRIPTION Create a Compute Engine reservation. EXAMPLES - To create a Compute Engine reservation, run: + To create a Compute Engine reservation by specifying VM properties using an + instance template, run: - $ gcloud compute reservations create my-reservation \ - --zone=fake-zone --vm-count=1 --machine-type=n1-standard-1 \ - --min-cpu-platform="Intel Haswell" + $ gcloud compute reservations create my-reservation --vm-count=1 \ + --source-instance-template=example-instance-template \ + --zone=fake-zone + + To create a Compute Engine reservation by directly specifying VM + properties, run: + + $ gcloud compute reservations create my-reservation --vm-count=1 \ + --machine-type=custom-8-10240 \ + --min-cpu-platform="Intel Haswell" \ + --accelerator=count=2,type=nvidia-tesla-v100 \ + --local-ssd=size=375,interface=scsi --zone=fake-zone POSITIONAL ARGUMENTS RESERVATION diff --git a/gcloud/compute/target-tcp-proxies/list b/gcloud/compute/target-tcp-proxies/list index 36eeec08e..eacddfe59 100644 --- a/gcloud/compute/target-tcp-proxies/list +++ b/gcloud/compute/target-tcp-proxies/list @@ -12,6 +12,10 @@ DESCRIPTION gcloud compute target-tcp-proxies list displays all Google Compute Engine target TCP proxies in a project. + By default, global target TCP proxies and target TCP proxies from all + regions are listed. The results can be narrowed down by providing the + --global or --regions flag. + EXAMPLES To list all target TCP proxies in a project in table form, run: @@ -21,6 +25,16 @@ EXAMPLES $ gcloud compute target-tcp-proxies list --uri + To list all global target TCP proxies in a project, run: + + $ gcloud compute target-tcp-proxies list --global + + To list all target TCP proxies in the us-central1 and europe-west1 regions, + given they are regional resources, run: + + $ gcloud compute target-tcp-proxies list \ + --filter="region:( europe-west1 us-central1 )" + POSITIONAL ARGUMENTS [NAME ...] (DEPRECATED) If provided, show details for the specified names and/or diff --git a/gcloud/container/clusters/upgrade b/gcloud/container/clusters/upgrade index 4b84051df..65b499692 100644 --- a/gcloud/container/clusters/upgrade +++ b/gcloud/container/clusters/upgrade @@ -11,35 +11,36 @@ SYNOPSIS DESCRIPTION Upgrades the Kubernetes version of an existing container cluster. - This command upgrades the Kubernetes version of the nodes or master of a - cluster. Note that the Kubernetes version of the cluster's master is also + This command upgrades the Kubernetes version of the node pools or master of + a cluster. Note that the Kubernetes version of the cluster's master is also periodically upgraded automatically as new releases are available. - If desired cluster version is omitted, node upgrades default to the current - master version and master upgrades default to the default cluster version, - which can be found in the server config. + If desired cluster version is omitted, node pool upgrades default to the + current master version and master upgrades default to the default cluster + version, which can be found in the server config. - By running this command, all of the cluster's nodes will be deleted and - recreated one at a time. While persistent Kubernetes resources, such as - pods backed by replication controllers, will be rescheduled onto new nodes, - a small cluster may experience a few minutes where there are insufficient - nodes available to run all of the scheduled Kubernetes resources. + During node pool upgrades, nodes will be deleted and recreated. While + persistent Kubernetes resources, such as Pods backed by replication + controllers, will be rescheduled onto new nodes, a small cluster may + experience a few minutes where there are insufficient nodes available to + run all of the scheduled Kubernetes resources. Please ensure that any data you wish to keep is stored on a persistent disk before upgrading the cluster. Ephemeral Kubernetes resources--in - particular, pods without replication controllers--will be lost, while + particular, Pods without replication controllers--will be lost, while persistent Kubernetes resources will get rescheduled. EXAMPLES - Upgrade the nodes of sample-cluster to the Kubernetes version of the - cluster's master. + Upgrade the node pool pool-1 of sample-cluster to the Kubernetes version of + the cluster's master. - $ gcloud container clusters upgrade sample-cluster + $ gcloud container clusters upgrade sample-cluster --node-pool=pool-1 - Upgrade the nodes of sample-cluster to Kubernetes version 1.14.7-gke.14: + Upgrade the node pool pool-1 of sample-cluster to Kubernetes version + 1.14.7-gke.14: $ gcloud container clusters upgrade sample-cluster \ - --cluster-version="1.14.7-gke.14" + --node-pool=pool-1 --cluster-version="1.14.7-gke.14" Upgrade the master of sample-cluster to the default cluster version: @@ -55,10 +56,11 @@ FLAGS complete. --cluster-version=CLUSTER_VERSION - The Kubernetes release version to which to upgrade the cluster's nodes. + The GKE release version to which to upgrade the cluster's node pools or + master. - If desired cluster version is omitted, node upgrades default to the - current master version and master upgrades default to the default + If desired cluster version is omitted, node pool upgrades default to + the current master version and master upgrades default to the default cluster version, which can be found in the server config. You can find the list of allowed versions for upgrades by running: @@ -81,8 +83,7 @@ FLAGS $ gcloud container get-server-config --master - Upgrade the cluster's master to the latest version of Kubernetes - supported on Kubernetes Engine. Nodes cannot be upgraded at the same + Upgrade the cluster's master. Node pools cannot be upgraded at the same time as the master. --node-pool=NODE_POOL diff --git a/gcloud/database-migration/connection-profiles/create/help b/gcloud/database-migration/connection-profiles/create/help index 4f8b659be..e7eee96a7 100644 --- a/gcloud/database-migration/connection-profiles/create/help +++ b/gcloud/database-migration/connection-profiles/create/help @@ -31,9 +31,6 @@ COMMANDS mysql Create a Database Migration Service connection profile for MySQL. - oracle - Create a Database Migration Service connection profile for Oracle. - postgresql Create a Database Migration Service connection profile for PostgreSQL. diff --git a/gcloud/database-migration/connection-profiles/create/oracle b/gcloud/database-migration/connection-profiles/create/oracle deleted file mode 100644 index 469fedb92..000000000 --- a/gcloud/database-migration/connection-profiles/create/oracle +++ /dev/null @@ -1,149 +0,0 @@ -NAME - gcloud database-migration connection-profiles create oracle - create a - Database Migration Service connection profile for Oracle - -SYNOPSIS - gcloud database-migration connection-profiles create oracle - (CONNECTION_PROFILE : --region=REGION) - --database-service=DATABASE_SERVICE --host=HOST --port=PORT - --username=USERNAME (--password=PASSWORD | --prompt-for-password) - [--no-async] [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] - [--private-connection=PRIVATE_CONNECTION : --static-ip-connectivity - | [--forward-ssh-hostname=FORWARD_SSH_HOSTNAME - --forward-ssh-username=FORWARD_SSH_USERNAME - (--forward-ssh-password=FORWARD_SSH_PASSWORD - | --forward-ssh-private-key=FORWARD_SSH_PRIVATE_KEY) - : --forward-ssh-port=FORWARD_SSH_PORT; default=22]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Create a Database Migration Service connection profile for Oracle. - -EXAMPLES - To create a connection profile for Oracle: - - $ gcloud database-migration connection-profiles create oracle \ - my-profile --region=us-central1 --password=123456 \ - --username=my-user --host=1.2.3.4 --port=5432 - -POSITIONAL ARGUMENTS - Connection profile resource - The connection profile to create. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument connection_profile on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONNECTION_PROFILE - ID of the connection_profile or fully qualified identifier for the - connection_profile. To set the connection_profile attribute: - ▸ provide the argument connection_profile on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the connection_profile. To set the region - attribute: - ▸ provide the argument connection_profile on the command line with - a fully specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - --database-service=DATABASE_SERVICE - database service for the oracle connection profile. - - --host=HOST - IP or hostname of the source database. - - --port=PORT - Network port of the source database. - - --username=USERNAME - Username that Database Migration Service uses to connect to the - database. Database Migration Service encrypts the value when storing - it. - - Exactly one of these must be specified: - - --password=PASSWORD - Password for the user that Database Migration Service uses to connect - to the source database. Database Migration Service encrypts the value - when storing it, and the field is not returned on request. - - --prompt-for-password - Prompt for the password used to connect to the database. - -OPTIONAL FLAGS - --no-async - Waits for the operation in progress to complete before returning. - - --display-name=DISPLAY_NAME - A user-friendly name for the connection profile. The display name can - include letters, numbers, spaces, and hyphens, and must start with a - letter. - - --labels=[KEY=VALUE,...] - List of label KEY=VALUE pairs to add. - - Keys must start with a lowercase character and contain only hyphens - (-), underscores (_), lowercase characters, and numbers. Values must - contain only hyphens (-), underscores (_), lowercase characters, and - numbers. - - At most one of these can be specified: - - Private connection resource - Resource ID of the private connection. - This represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ▸ provide the argument --private-connection on the command line with - a fully specified name; - ▸ provide the argument --project on the command line; - ▸ set the property core/project. To set the region attribute: - ▸ provide the argument --private-connection on the command line with - a fully specified name; - ▸ provide the argument --region on the command line. - - --private-connection=PRIVATE_CONNECTION - ID of the private_connection or fully qualified identifier for the - private_connection. To set the private_connection attribute: - ▫ provide the argument --private-connection on the command line. - - --static-ip-connectivity - use static ip connectivity - - --forward-ssh-hostname=FORWARD_SSH_HOSTNAME - Hostname for the SSH tunnel. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --forward-ssh-username=FORWARD_SSH_USERNAME - Username for the SSH tunnel. - - This flag argument must be specified if any of the other arguments in - this group are specified. - - --forward-ssh-port=FORWARD_SSH_PORT; default=22 - Port for the SSH tunnel, default value is 22. - - Exactly one of these must be specified: - - --forward-ssh-password=FORWARD_SSH_PASSWORD - SSH password. - - --forward-ssh-private-key=FORWARD_SSH_PRIVATE_KEY - SSH private key.. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/connection-profiles/create/postgresql b/gcloud/database-migration/connection-profiles/create/postgresql index 29921786e..496459e2e 100644 --- a/gcloud/database-migration/connection-profiles/create/postgresql +++ b/gcloud/database-migration/connection-profiles/create/postgresql @@ -10,8 +10,7 @@ SYNOPSIS [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] [--ca-certificate=CA_CERTIFICATE : --client-certificate=CLIENT_CERTIFICATE --private-key=PRIVATE_KEY] - [--psc-service-attachment=PSC_SERVICE_ATTACHMENT - : --static-ip-connectivity] [GCLOUD_WIDE_FLAG ...] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a Database Migration Service connection profile for PostgreSQL. @@ -116,29 +115,6 @@ OPTIONAL FLAGS the Client Certificate. Database Migration Service encrypts the value when storing it. - At most one of these can be specified: - - Service attachment resource - Resource ID of the service attachment. - This represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ▸ provide the argument --psc-service-attachment on the command line - with a fully specified name; - ▸ provide the argument --project on the command line; - ▸ set the property core/project. To set the region attribute: - ▸ provide the argument --psc-service-attachment on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - - --psc-service-attachment=PSC_SERVICE_ATTACHMENT - ID of the service_attachment or fully qualified identifier for the - service_attachment. To set the service_attachment attribute: - ▫ provide the argument --psc-service-attachment on the command - line. - - --static-ip-connectivity - use static ip connectivity - GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/database-migration/conversion-workspaces/apply b/gcloud/database-migration/conversion-workspaces/apply deleted file mode 100644 index 072c0ada6..000000000 --- a/gcloud/database-migration/conversion-workspaces/apply +++ /dev/null @@ -1,84 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces apply - apply a Database - Migration Service conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces apply - (CONVERSION_WORKSPACE : --region=REGION) - --destination-connection-profile=DESTINATION_CONNECTION_PROFILE - [--no-async] [--filter-string=FILTER_STRING] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Apply Database Migration Service conversion workspace onto the destination - database. - -EXAMPLES - To apply a conversion workspace: - - $ gcloud database-migration conversion-workspaces apply \ - my-conversion-workspace --region=us-central1 \ - --destination-connection-profile=projects/$$PROJECT_ID$$/\ - locations/us-central1/connectionProfiles/cp1 - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace to apply. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the conversion_workspace. To set the region - attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - Connection profile resource - The connection profile to apply to. This - represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ◆ provide the argument --destination-connection-profile on the command - line with a fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. To set the region attribute: - ◆ provide the argument --destination-connection-profile on the command - line with a fully specified name; - ◆ provide the argument --region on the command line. - - This must be specified. - - --destination-connection-profile=DESTINATION_CONNECTION_PROFILE - ID of the connection_profile or fully qualified identifier for the - connection_profile. To set the connection_profile attribute: - ▸ provide the argument --destination-connection-profile on the - command line. - -OPTIONAL FLAGS - --no-async - Waits for the operation in progress to complete before returning. - - --filter-string=FILTER_STRING - Filter the entities based on AIP-160 standard. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/conversion-workspaces/commit b/gcloud/database-migration/conversion-workspaces/commit deleted file mode 100644 index b9d74544e..000000000 --- a/gcloud/database-migration/conversion-workspaces/commit +++ /dev/null @@ -1,62 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces commit - commit a Database - Migration Service conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces commit - (CONVERSION_WORKSPACE : --region=REGION) [--no-async] - [--commit-name=COMMIT_NAME] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Commit a Database Migration Service conversion workspace. - -EXAMPLES - To commit a conversion workspace: - - $ gcloud database-migration conversion-workspaces commit \ - my-conversion-workspace --region=us-central1 \ - --commit-name=my-commit - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace to commit. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the conversion_workspace. To set the region - attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --no-async - Waits for the operation in progress to complete before returning. - - --commit-name=COMMIT_NAME - A user-friendly name for the conversion workspace commit. The commit - name can include letters, numbers, spaces, and hyphens, and must start - with a letter. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/conversion-workspaces/convert b/gcloud/database-migration/conversion-workspaces/convert deleted file mode 100644 index 80e23df09..000000000 --- a/gcloud/database-migration/conversion-workspaces/convert +++ /dev/null @@ -1,62 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces convert - convert a - Database Migration Service conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces convert - (CONVERSION_WORKSPACE : --region=REGION) [--no-async] [--auto-commit] - [--filter-string=FILTER_STRING] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Convert a Database Migration Service conversion workspace. - -EXAMPLES - To convert a conversion workspace: - - $ gcloud database-migration conversion-workspaces convert \ - my-conversion-workspace --region=us-central1 - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace to convert. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the conversion_workspace. To set the region - attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --no-async - Waits for the operation in progress to complete before returning. - - --auto-commit - Auto commits the conversion workspace. - - --filter-string=FILTER_STRING - Filter the entities based on AIP-160 standard. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/conversion-workspaces/create b/gcloud/database-migration/conversion-workspaces/create deleted file mode 100644 index ed50cb95c..000000000 --- a/gcloud/database-migration/conversion-workspaces/create +++ /dev/null @@ -1,91 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces create - create a Database - Migration Service conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces create - (CONVERSION_WORKSPACE : --region=REGION) - --destination-database-engine=DESTINATION_DATABASE_ENGINE - --destination-database-version=DESTINATION_DATABASE_VERSION - --source-database-engine=SOURCE_DATABASE_ENGINE - --source-database-version=SOURCE_DATABASE_VERSION [--no-async] - [--display-name=DISPLAY_NAME] [--global-settings=[KEY=VALUE,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Create a Database Migration Service conversion workspace. - -EXAMPLES - To create a conversion workspace: - - $ gcloud database-migration conversion-workspaces create \ - my-conversion-workspace --region=us-central1 \ - --display-name=cw1 --source-database-engine=ORACLE \ - --source-database-version=11 \ - --destination-database-engine=POSTGRESQL \ - --destination-database-version=8 - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace to create. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the conversion_workspace. To set the region - attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - --destination-database-engine=DESTINATION_DATABASE_ENGINE - Database engine type. DESTINATION_DATABASE_ENGINE must be one of: - MYSQL, POSTGRESQL, SQLSERVER, ORACLE, SPANNER. - - --destination-database-version=DESTINATION_DATABASE_VERSION - Version number for the database engine. - - --source-database-engine=SOURCE_DATABASE_ENGINE - Database engine type. SOURCE_DATABASE_ENGINE must be one of: MYSQL, - POSTGRESQL, SQLSERVER, ORACLE, SPANNER. - - --source-database-version=SOURCE_DATABASE_VERSION - Version number for the database engine. - -OPTIONAL FLAGS - --no-async - Waits for the operation in progress to complete before returning. - - --display-name=DISPLAY_NAME - A user-friendly name for the conversion workspace. The display name can - include letters, numbers, spaces, and hyphens, and must start with a - letter. - - --global-settings=[KEY=VALUE,...] - A generic list of settings for the workspace. The settings are database - pair dependant and can indicate default behavior for the mapping rules - engine or turn on or off specific features. An object containing a list - of "key": "value" pairs. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/conversion-workspaces/delete b/gcloud/database-migration/conversion-workspaces/delete deleted file mode 100644 index b1256dd34..000000000 --- a/gcloud/database-migration/conversion-workspaces/delete +++ /dev/null @@ -1,56 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces delete - delete a Database - Migration conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces delete - (CONVERSION_WORKSPACE : --region=REGION) [--no-async] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Delete a Database Migration conversion workspace - -EXAMPLES - To delete a conversion workspace called 'my-conversion-workspace', run: - - $ gcloud database-migration conversion-workspaces delete \ - my-conversion-workspace --region=us-central1 - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace to delete. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the conversion_workspace. To set the region - attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --no-async - Waits for the operation in progress to complete before returning. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/conversion-workspaces/describe b/gcloud/database-migration/conversion-workspaces/describe deleted file mode 100644 index 935c1d7cc..000000000 --- a/gcloud/database-migration/conversion-workspaces/describe +++ /dev/null @@ -1,55 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces describe - show details - about a database migration conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces describe - (CONVERSION_WORKSPACE : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Show details about a conversion workspace. - -EXAMPLES - To show details about a conversion workspace, run: - - $ gcloud database-migration conversion-workspaces describe \ - my-conversion-workspace --region=us-central1 - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace you want to get - the details of. The arguments in this group can be used to specify the - attributes of this resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the region. To set the region attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. - -API REFERENCE - This command uses the datamigration/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/conversion-workspaces/describe-entities b/gcloud/database-migration/conversion-workspaces/describe-entities deleted file mode 100644 index b85e4c909..000000000 --- a/gcloud/database-migration/conversion-workspaces/describe-entities +++ /dev/null @@ -1,78 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces describe-entities - - describe database entities in the conversion workspaces - -SYNOPSIS - gcloud database-migration conversion-workspaces describe-entities - (CONVERSION_WORKSPACE : --region=REGION) --tree-type=TREE_TYPE - [--commit-id=COMMIT_ID] [--filter-string=FILTER_STRING] [--uncommitted] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Describe database entities (SOURCE/DRAFT/DESTINATION) in the conversion - workspaces. - -EXAMPLES - To describe the source entities in a conversion workspaces in a project and - location us-central1, run: - - $ gcloud database-migration conversion-workspaces \ - describe-entities my-conversion-workspace --region=us-central1 \ - --tree-type=SOURCE - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace you want to get - the details of. The arguments in this group can be used to specify the - attributes of this resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the region. To set the region attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - --tree-type=TREE_TYPE - The type of tree to return. TREE_TYPE must be one of: - db-tree-type-unspecified, destination-tree, draft-tree, source-tree. - -OPTIONAL FLAGS - --commit-id=COMMIT_ID - Request a specific commit id. If not specified, the entities from the - latest commit are returned. - - --filter-string=FILTER_STRING - Filter the returned entities based on AIP-160 standard. - - --uncommitted - Whether to retrieve the latest committed version of the entities or the - latest version. This field is ignored if a specific commit_id is - specified. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. - -API REFERENCE - This command uses the datamigration/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/conversion-workspaces/help b/gcloud/database-migration/conversion-workspaces/help deleted file mode 100644 index 1776c096a..000000000 --- a/gcloud/database-migration/conversion-workspaces/help +++ /dev/null @@ -1,54 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces - manage Database Migration - Service conversion workspaces - -SYNOPSIS - gcloud database-migration conversion-workspaces COMMAND - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Commands for managing Database Migration Service conversion workspaces. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - apply - Apply a Database Migration Service conversion workspace. - - commit - Commit a Database Migration Service conversion workspace. - - convert - Convert a Database Migration Service conversion workspace. - - create - Create a Database Migration Service conversion workspace. - - delete - Delete a Database Migration conversion workspace. - - describe - Show details about a database migration conversion workspace. - - describe-entities - Describe database entities in the conversion workspaces. - - list - List conversion workspaces. - - list-background-jobs - List background jobs in the conversion workspaces. - - rollback - Rollback a Database Migration Service conversion workspace. - - seed - Seed a Database Migration Service conversion workspace. - - update - Update a Database Migration Service conversion workspace. diff --git a/gcloud/database-migration/conversion-workspaces/list-background-jobs b/gcloud/database-migration/conversion-workspaces/list-background-jobs deleted file mode 100644 index d724ef07e..000000000 --- a/gcloud/database-migration/conversion-workspaces/list-background-jobs +++ /dev/null @@ -1,67 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces list-background-jobs - list - background jobs in the conversion workspaces - -SYNOPSIS - gcloud database-migration conversion-workspaces list-background-jobs - (CONVERSION_WORKSPACE : --region=REGION) [--max-size=MAX_SIZE] - [--most-recent-per-job-type] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - List background jobs in the conversion workspaces. - -EXAMPLES - To list the background jobs in a conversion workspaces in a project and - location us-central1, run: - - $ gcloud database-migration conversion-workspaces \ - list-background-jobs my-conversion-workspace \ - --region=us-central1 - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace you want to get - the details of. The arguments in this group can be used to specify the - attributes of this resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the region. To set the region attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --max-size=MAX_SIZE - The maximum number of jobs to return. The service may return fewer than - this value. If unspecified, at most 100 jobs will be returned. The - maximum value is 100; values above 100 will be coerced to 100. - - --most-recent-per-job-type - Returns only the most recent job per job type. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. - -API REFERENCE - This command uses the datamigration/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/conversion-workspaces/rollback b/gcloud/database-migration/conversion-workspaces/rollback deleted file mode 100644 index a884b82d9..000000000 --- a/gcloud/database-migration/conversion-workspaces/rollback +++ /dev/null @@ -1,56 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces rollback - rollback a - Database Migration Service conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces rollback - (CONVERSION_WORKSPACE : --region=REGION) [--no-async] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Rollback a Database Migration Service conversion workspace. - -EXAMPLES - To rollback a conversion workspace: - - $ gcloud database-migration conversion-workspaces rollback \ - my-conversion-workspace --region=us-central1 - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace to rollback. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the conversion_workspace. To set the region - attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --no-async - Waits for the operation in progress to complete before returning. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/conversion-workspaces/seed b/gcloud/database-migration/conversion-workspaces/seed deleted file mode 100644 index ba83e225d..000000000 --- a/gcloud/database-migration/conversion-workspaces/seed +++ /dev/null @@ -1,101 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces seed - seed a Database - Migration Service conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces seed - (CONVERSION_WORKSPACE : --region=REGION) - (--destination-connection-profile=DESTINATION_CONNECTION_PROFILE - | --source-connection-profile=SOURCE_CONNECTION_PROFILE) [--no-async] - [--auto-commit] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Seed a Database Migration Service conversion workspace. - -EXAMPLES - To seed a conversion workspace: - - $ gcloud database-migration conversion-workspaces seed \ - my-conversion-workspace --region=us-central1 \ - --source-connection-profile=cp1 - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace to seed. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the conversion_workspace. To set the region - attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - Exactly one of these must be specified: - - Connection profile resource - The connection profile to seed from. This - represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ▸ provide the argument --destination-connection-profile on the - command line with a fully specified name; - ▸ provide the argument --project on the command line; - ▸ set the property core/project. To set the region attribute: - ▸ provide the argument --destination-connection-profile on the - command line with a fully specified name; - ▸ provide the argument --region on the command line. - - --destination-connection-profile=DESTINATION_CONNECTION_PROFILE - ID of the connection_profile or fully qualified identifier for the - connection_profile. To set the connection_profile attribute: - ▫ provide the argument --destination-connection-profile on the - command line. - - Connection profile resource - The connection profile to seed from. This - represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ▸ provide the argument --source-connection-profile on the command - line with a fully specified name; - ▸ provide the argument --project on the command line; - ▸ set the property core/project. To set the region attribute: - ▸ provide the argument --source-connection-profile on the command - line with a fully specified name; - ▸ provide the argument --region on the command line. - - --source-connection-profile=SOURCE_CONNECTION_PROFILE - ID of the connection_profile or fully qualified identifier for the - connection_profile. To set the connection_profile attribute: - ▫ provide the argument --source-connection-profile on the command - line. - -OPTIONAL FLAGS - --no-async - Waits for the operation in progress to complete before returning. - - --auto-commit - Auto commits the conversion workspace. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/conversion-workspaces/update b/gcloud/database-migration/conversion-workspaces/update deleted file mode 100644 index a3791c4e8..000000000 --- a/gcloud/database-migration/conversion-workspaces/update +++ /dev/null @@ -1,62 +0,0 @@ -NAME - gcloud database-migration conversion-workspaces update - update a Database - Migration Service conversion workspace - -SYNOPSIS - gcloud database-migration conversion-workspaces update - (CONVERSION_WORKSPACE : --region=REGION) [--no-async] - [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Update a Database Migration Service conversion workspace. - -EXAMPLES - To update a conversion workspace: - - $ gcloud database-migration conversion-workspaces update \ - my-conversion-workspace --region=us-central1 \ - --display-name=new-display-name - -POSITIONAL ARGUMENTS - Conversion workspace resource - The conversion workspace to update. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument conversion_workspace on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - CONVERSION_WORKSPACE - ID of the conversion_workspace or fully qualified identifier for the - conversion_workspace. To set the conversion_workspace attribute: - ▸ provide the argument conversion_workspace on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the conversion_workspace. To set the region - attribute: - ▸ provide the argument conversion_workspace on the command line - with a fully specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --no-async - Waits for the operation in progress to complete before returning. - - --display-name=DISPLAY_NAME - A user-friendly name for the conversion workspace. The display name can - include letters, numbers, spaces, and hyphens, and must start with a - letter. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/help b/gcloud/database-migration/help index ba0e60610..ca24c3fef 100644 --- a/gcloud/database-migration/help +++ b/gcloud/database-migration/help @@ -18,18 +18,12 @@ GROUPS connection-profiles Manage Database Migration Service connection profiles. - conversion-workspaces - Manage Database Migration Service conversion workspaces. - migration-jobs Manage Database Migration Service migration jobs. operations Manage Database Migration Service operations. - private-connections - Manage Database Migration Service private connections. - NOTES This variant is also available: diff --git a/gcloud/database-migration/private-connections/create b/gcloud/database-migration/private-connections/create deleted file mode 100644 index c7d0be973..000000000 --- a/gcloud/database-migration/private-connections/create +++ /dev/null @@ -1,94 +0,0 @@ -NAME - gcloud database-migration private-connections create - create a Database - Migration private connection - -SYNOPSIS - gcloud database-migration private-connections create - (PRIVATE_CONNECTION : --region=REGION) --display-name=DISPLAY_NAME - (--subnet=SUBNET --vpc=VPC) [--no-async] [--labels=[KEY=VALUE,...]] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Create a Database Migration private connection - -EXAMPLES - To create a privateConnection called 'my-privateConnection', run: - - $ gcloud database-migration private-connections create \ - my-privateConnection --region=us-central1 \ - --display-name=my-privateConnection --vpc=vpc-example \ - --subnet=10.0.0.0/29 - -POSITIONAL ARGUMENTS - Private connection resource - The private connection to create. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument private_connection on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - PRIVATE_CONNECTION - ID of the private_connection or fully qualified identifier for the - private_connection. To set the private_connection attribute: - ▸ provide the argument private_connection on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the private_connection. To set the region - attribute: - ▸ provide the argument private_connection on the command line with - a fully specified name; - ▸ provide the argument --region on the command line. - -REQUIRED FLAGS - --display-name=DISPLAY_NAME - Friendly name for the private connection. - - This must be specified. - - --subnet=SUBNET - A free subnet for peering. (CIDR of /29). - - This flag argument must be specified if any of the other arguments in - this group are specified. - - Vpc resource - Resource ID of the private connection. This represents a - Cloud resource. (NOTE) Some attributes are not given arguments in this - group but can be set in other ways. To set the project attribute: - ▸ provide the argument --vpc on the command line with a fully - specified name; - ▸ provide the argument --project on the command line; - ▸ set the property core/project. - - This must be specified. - - --vpc=VPC - ID of the vpc or fully qualified identifier for the vpc. To set the - vpc attribute: - ▫ provide the argument --vpc on the command line. - -OPTIONAL FLAGS - --no-async - Waits for the operation in progress to complete before returning. - - --labels=[KEY=VALUE,...] - List of label KEY=VALUE pairs to add. - - Keys must start with a lowercase character and contain only hyphens - (-), underscores (_), lowercase characters, and numbers. Values must - contain only hyphens (-), underscores (_), lowercase characters, and - numbers. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/private-connections/delete b/gcloud/database-migration/private-connections/delete deleted file mode 100644 index b31b7ee10..000000000 --- a/gcloud/database-migration/private-connections/delete +++ /dev/null @@ -1,56 +0,0 @@ -NAME - gcloud database-migration private-connections delete - delete a Database - Migration private connection - -SYNOPSIS - gcloud database-migration private-connections delete - (PRIVATE_CONNECTION : --region=REGION) [--no-async] - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Delete a Database Migration private connection - -EXAMPLES - To delete a privateConnection called 'my-privateConnection', run: - - $ gcloud database-migration private-connections delete \ - my-privateConnection --region=us-central1 - -POSITIONAL ARGUMENTS - Private connection resource - The private connection to delete. The - arguments in this group can be used to specify the attributes of this - resource. (NOTE) Some attributes are not given arguments in this group but - can be set in other ways. To set the project attribute: - ◆ provide the argument private_connection on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - PRIVATE_CONNECTION - ID of the private_connection or fully qualified identifier for the - private_connection. To set the private_connection attribute: - ▸ provide the argument private_connection on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The Cloud region for the private_connection. To set the region - attribute: - ▸ provide the argument private_connection on the command line with - a fully specified name; - ▸ provide the argument --region on the command line. - -FLAGS - --no-async - Waits for the operation in progress to complete before returning. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. diff --git a/gcloud/database-migration/private-connections/describe b/gcloud/database-migration/private-connections/describe deleted file mode 100644 index 03632aa89..000000000 --- a/gcloud/database-migration/private-connections/describe +++ /dev/null @@ -1,55 +0,0 @@ -NAME - gcloud database-migration private-connections describe - show details about - a database migration private connection - -SYNOPSIS - gcloud database-migration private-connections describe - (PRIVATE_CONNECTION : --region=REGION) [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Show details about a private connection. - -EXAMPLES - To show details about a private connection, run: - - $ gcloud database-migration private-connections describe \ - my-private-connection --region=us-central1 - -POSITIONAL ARGUMENTS - Private connection resource - The private connection you want to get the - details of. The arguments in this group can be used to specify the - attributes of this resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. To set the project - attribute: - ◆ provide the argument private_connection on the command line with a - fully specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. - - This must be specified. - - PRIVATE_CONNECTION - ID of the private_connection or fully qualified identifier for the - private_connection. To set the private_connection attribute: - ▸ provide the argument private_connection on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the region. To set the region attribute: - ▸ provide the argument private_connection on the command line with - a fully specified name; - ▸ provide the argument --region on the command line. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --access-token-file, --account, - --billing-project, --configuration, --flags-file, --flatten, --format, - --help, --impersonate-service-account, --log-http, --project, --quiet, - --trace-token, --user-output-enabled, --verbosity. - - Run $ gcloud help for details. - -API REFERENCE - This command uses the datamigration/v1 API. The full documentation for this - API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/private-connections/help b/gcloud/database-migration/private-connections/help deleted file mode 100644 index 02b77f750..000000000 --- a/gcloud/database-migration/private-connections/help +++ /dev/null @@ -1,30 +0,0 @@ -NAME - gcloud database-migration private-connections - manage Database Migration - Service private connections - -SYNOPSIS - gcloud database-migration private-connections COMMAND - [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - Commands for managing Database Migration Service private connections. - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - create - Create a Database Migration private connection. - - delete - Delete a Database Migration private connection. - - describe - Show details about a database migration private connection. - - list - List private connections. diff --git a/gcloud/dataproc/clusters/create b/gcloud/dataproc/clusters/create index d7f3e5ce1..0eb3a1df3 100644 --- a/gcloud/dataproc/clusters/create +++ b/gcloud/dataproc/clusters/create @@ -6,7 +6,15 @@ SYNOPSIS --autoscaling-policy=AUTOSCALING_POLICY [--action-on-failed-primary-workers=ACTION_ON_FAILED_PRIMARY_WORKERS] [--no-address] [--async] [--bucket=BUCKET] [--confidential-compute] - [--dataproc-metastore=DATAPROC_METASTORE] [--enable-component-gateway] + [--dataproc-metastore=DATAPROC_METASTORE] + [--driver-pool-accelerator=[type=TYPE,[count=COUNT],...]] + [--driver-pool-boot-disk-size=DRIVER_POOL_BOOT_DISK_SIZE] + [--driver-pool-boot-disk-type=DRIVER_POOL_BOOT_DISK_TYPE] + [--driver-pool-id=DRIVER_POOL_ID] + [--driver-pool-local-ssd-interface=DRIVER_POOL_LOCAL_SSD_INTERFACE] + [--driver-pool-machine-type=DRIVER_POOL_MACHINE_TYPE] + [--driver-pool-min-cpu-platform=PLATFORM] + [--driver-pool-size=DRIVER_POOL_SIZE] [--enable-component-gateway] [--initialization-action-timeout=TIMEOUT; default="10m"] [--initialization-actions=CLOUD_STORAGE_URI,[...]] [--labels=[KEY=VALUE,...]] @@ -17,6 +25,7 @@ SYNOPSIS [--master-machine-type=MASTER_MACHINE_TYPE] [--master-min-cpu-platform=PLATFORM] [--max-idle=MAX_IDLE] [--node-group=NODE_GROUP] + [--num-driver-pool-local-ssds=NUM_DRIVER_POOL_LOCAL_SSDS] [--num-master-local-ssds=NUM_MASTER_LOCAL_SSDS] [--num-masters=NUM_MASTERS] [--num-secondary-worker-local-ssds=NUM_SECONDARY_WORKER_LOCAL_SSDS] @@ -148,6 +157,55 @@ FLAGS external metastore in the format: "projects/{project-id}/locations/{region}/services/{service-name}". + --driver-pool-accelerator=[type=TYPE,[count=COUNT],...] + Attaches accelerators, such as GPUs, to the driver-pool instance(s). + + type + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. + + count + The number of accelerators to attach to each instance. The default + value is 1. + + --driver-pool-boot-disk-size=DRIVER_POOL_BOOT_DISK_SIZE + The size of the boot disk. The value must be a whole number followed by + a size unit of KB for kilobyte, MB for megabyte, GB for gigabyte, or TB + for terabyte. For example, 10GB will produce a 10 gigabyte disk. The + minimum size a boot disk can have is 10 GB. Disk size must be a + multiple of 1 GB. + + --driver-pool-boot-disk-type=DRIVER_POOL_BOOT_DISK_TYPE + The type of the boot disk. The value must be pd-balanced, pd-ssd, or + pd-standard. + + --driver-pool-id=DRIVER_POOL_ID + Custom identifier for the DRIVER Node Group being created. If not + provided, a random string is generated. + + --driver-pool-local-ssd-interface=DRIVER_POOL_LOCAL_SSD_INTERFACE + Interface to use to attach local SSDs to cluster driver pool node(s). + + --driver-pool-machine-type=DRIVER_POOL_MACHINE_TYPE + The type of machine to use for the cluster driver pool nodes. Defaults + to server-specified. + + --driver-pool-min-cpu-platform=PLATFORM + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: + + $ gcloud compute zones describe ZONE + + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). + + --driver-pool-size=DRIVER_POOL_SIZE + The size of the cluster driver pool. + --enable-component-gateway Enable access to the web UIs of selected components on the cluster through the component gateway. @@ -169,17 +227,16 @@ FLAGS numbers. --master-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the master instance(s). + Attaches accelerators, such as GPUs, to the master instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --master-boot-disk-size=MASTER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -200,18 +257,16 @@ FLAGS server-specified. --master-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --max-idle=MAX_IDLE The duration before cluster is auto-deleted after last job completes, @@ -223,6 +278,9 @@ FLAGS a short name ("node-group-name") or in the format "projects/{project-id}/zones/{zone}/nodeGroups/{node-group-name}". + --num-driver-pool-local-ssds=NUM_DRIVER_POOL_LOCAL_SSDS + The number of local SSDs to attach to each cluster driver pool node. + --num-master-local-ssds=NUM_MASTER_LOCAL_SSDS The number of local SSDs to attach to the master in a cluster. @@ -288,17 +346,17 @@ FLAGS for more information. --secondary-worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the secondary-worker instance(s). + Attaches accelerators, such as GPUs, to the secondary-worker + instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --secondary-worker-boot-disk-size=SECONDARY_WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -336,17 +394,16 @@ FLAGS cluster and jobs data, such as Spark and MapReduce history files. --worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the worker instance(s). + Attaches accelerators, such as GPUs, to the worker instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --worker-boot-disk-size=WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by @@ -366,18 +423,16 @@ FLAGS The type of machine to use for workers. Defaults to server-specified. --worker-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --zone=ZONE, -z ZONE The compute zone (e.g. us-central1-a) for the cluster. If empty and diff --git a/gcloud/dataproc/help b/gcloud/dataproc/help index d7b00f49b..25d3ebb77 100644 --- a/gcloud/dataproc/help +++ b/gcloud/dataproc/help @@ -45,6 +45,9 @@ GROUPS jobs Submit and manage Dataproc jobs. + node-groups + Manage Dataproc node groups. + operations View and manage Dataproc operations. diff --git a/gcloud/dataproc/node-groups/describe b/gcloud/dataproc/node-groups/describe new file mode 100644 index 000000000..434b9132e --- /dev/null +++ b/gcloud/dataproc/node-groups/describe @@ -0,0 +1,68 @@ +NAME + gcloud dataproc node-groups describe - describe the node group + +SYNOPSIS + gcloud dataproc node-groups describe + (NODE_GROUP : --cluster=CLUSTER --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe the node group. + +EXAMPLES + To describe a node group, run: + + $ gcloud dataproc node-groups describe my-node-group-id \ + --region=us-central1 --cluster=my-cluster-name + +POSITIONAL ARGUMENTS + Node group resource - ID of the node group to describe. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument node_group on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + NODE_GROUP + ID of the node_group or fully qualified identifier for the + node_group. To set the node_group attribute: + ▸ provide the argument node_group on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The Cluster name. To set the cluster attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + Dataproc region for the node_group. Each Dataproc region constitutes + an independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha dataproc node-groups describe + + $ gcloud beta dataproc node-groups describe + diff --git a/gcloud/dataproc/node-groups/help b/gcloud/dataproc/node-groups/help new file mode 100644 index 000000000..2a28a3c5b --- /dev/null +++ b/gcloud/dataproc/node-groups/help @@ -0,0 +1,41 @@ +NAME + gcloud dataproc node-groups - manage Dataproc node groups + +SYNOPSIS + gcloud dataproc node-groups COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage and modify Dataproc node groups created with a parent cluster. + +EXAMPLES + To describe a node group: + + $ gcloud dataproc node-groups describe NODE_GROUP_ID \ + --cluster cluster_name --region region + + To resize a node group: + + $ gcloud dataproc node-groups resize NODE_GROUP_ID \ + --cluster cluster_name --region region --size new_size + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Describe the node group. + + resize + Resize the number of nodes in the node group. + +NOTES + These variants are also available: + + $ gcloud alpha dataproc node-groups + + $ gcloud beta dataproc node-groups + diff --git a/gcloud/dataproc/node-groups/resize b/gcloud/dataproc/node-groups/resize new file mode 100644 index 000000000..0475afb20 --- /dev/null +++ b/gcloud/dataproc/node-groups/resize @@ -0,0 +1,79 @@ +NAME + gcloud dataproc node-groups resize - resize the number of nodes in the node + group + +SYNOPSIS + gcloud dataproc node-groups resize + (NODE_GROUP : --cluster=CLUSTER --region=REGION) --size=SIZE + [--graceful-decommission-timeout=GRACEFUL_DECOMMISSION_TIMEOUT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Resize the number of nodes in the node group. + +EXAMPLES + To resize a node group, run: + + $ gcloud dataproc node-groups resize my-node-group-id \ + --region=us-central1 --cluster=my-cluster-name --size=5 + +POSITIONAL ARGUMENTS + Node group resource - ID of the node group to resize. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: + ◆ provide the argument node_group on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + NODE_GROUP + ID of the node_group or fully qualified identifier for the + node_group. To set the node_group attribute: + ▸ provide the argument node_group on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The Cluster name. To set the cluster attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + Dataproc region for the node_group. Each Dataproc region constitutes + an independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument node_group on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +REQUIRED FLAGS + --size=SIZE + New size for a node group. + +OPTIONAL FLAGS + --graceful-decommission-timeout=GRACEFUL_DECOMMISSION_TIMEOUT + Graceful decommission timeout for a node group scale-down resize. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha dataproc node-groups resize + + $ gcloud beta dataproc node-groups resize + diff --git a/gcloud/dataproc/workflow-templates/set-managed-cluster b/gcloud/dataproc/workflow-templates/set-managed-cluster index a3ce3f2e9..6b1a4d6f6 100644 --- a/gcloud/dataproc/workflow-templates/set-managed-cluster +++ b/gcloud/dataproc/workflow-templates/set-managed-cluster @@ -155,24 +155,23 @@ FLAGS numbers. --master-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the master instance(s). + Attaches accelerators, such as GPUs, to the master instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --master-boot-disk-size=MASTER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by a size unit of KB for kilobyte, MB for megabyte, GB for gigabyte, or TB for terabyte. For example, 10GB will produce a 10 gigabyte disk. The - minimum size a boot disk can have is 10 GB. Disk size must be a - multiple of 1 GB. + minimum boot disk size is 10 GB. Boot disk size must be a multiple of 1 + GB. --master-boot-disk-type=MASTER_BOOT_DISK_TYPE The type of the boot disk. The value must be pd-balanced, pd-ssd, or @@ -186,18 +185,16 @@ FLAGS server-specified. --master-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --node-group=NODE_GROUP The name of the sole-tenant node group to create the cluster on. Can be @@ -269,24 +266,24 @@ FLAGS for more information. --secondary-worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the secondary-worker instance(s). + Attaches accelerators, such as GPUs, to the secondary-worker + instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --secondary-worker-boot-disk-size=SECONDARY_WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by a size unit of KB for kilobyte, MB for megabyte, GB for gigabyte, or TB for terabyte. For example, 10GB will produce a 10 gigabyte disk. The - minimum size a boot disk can have is 10 GB. Disk size must be a - multiple of 1 GB. + minimum boot disk size is 10 GB. Boot disk size must be a multiple of 1 + GB. --secondary-worker-boot-disk-type=SECONDARY_WORKER_BOOT_DISK_TYPE The type of the boot disk. The value must be pd-balanced, pd-ssd, or @@ -317,24 +314,23 @@ FLAGS cluster and jobs data, such as Spark and MapReduce history files. --worker-accelerator=[type=TYPE,[count=COUNT],...] - Attaches accelerators (e.g. GPUs) to the worker instance(s). + Attaches accelerators, such as GPUs, to the worker instance(s). type - The specific type (e.g. nvidia-tesla-k80 for nVidia Tesla K80) of - accelerator to attach to the instances. Use 'gcloud compute - accelerator-types list' to learn about all available accelerator - types. + The specific type of accelerator to attach to the instances, such + as nvidia-tesla-k80 for NVIDIA Tesla K80. Use gcloud compute + accelerator-types list to display available accelerator types. count - The number of pieces of the accelerator to attach to each of the - instances. The default value is 1. + The number of accelerators to attach to each instance. The default + value is 1. --worker-boot-disk-size=WORKER_BOOT_DISK_SIZE The size of the boot disk. The value must be a whole number followed by a size unit of KB for kilobyte, MB for megabyte, GB for gigabyte, or TB for terabyte. For example, 10GB will produce a 10 gigabyte disk. The - minimum size a boot disk can have is 10 GB. Disk size must be a - multiple of 1 GB. + minimum boot disk size is 10 GB. Boot disk size must be a multiple of 1 + GB. --worker-boot-disk-type=WORKER_BOOT_DISK_TYPE The type of the boot disk. The value must be pd-balanced, pd-ssd, or @@ -347,18 +343,16 @@ FLAGS The type of machine to use for workers. Defaults to server-specified. --worker-min-cpu-platform=PLATFORM - When specified, the VM will be scheduled on host with specified CPU - architecture or a newer one. To list available CPU platforms in given - zone, run: + When specified, the VM is scheduled on the host with a specified CPU + architecture or a more recent CPU platform that's available in that + zone. To list available CPU platforms in a zone, run: $ gcloud compute zones describe ZONE - CPU platform selection is available only in selected zones; zones that - allow CPU platform selection will have an availableCpuPlatforms field - that contains the list of available CPU platforms for that zone. - - You can find more information online: - https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform + CPU platform selection may not be available in a zone. Zones that + support CPU platform selection provide an availableCpuPlatforms field, + which contains the list of available CPU platforms in the zone (see + Availability of CPU platforms for more information). --zone=ZONE The compute zone (e.g. us-central1-a) for the cluster. If empty and diff --git a/gcloud/edge-cloud/container/vpn-connections/create b/gcloud/edge-cloud/container/vpn-connections/create index bb5554cd1..721099922 100644 --- a/gcloud/edge-cloud/container/vpn-connections/create +++ b/gcloud/edge-cloud/container/vpn-connections/create @@ -57,7 +57,7 @@ REQUIRED FLAGS --vpc-network=VPC_NETWORK The name of the VPC network to be connected. By default it is assumed to be under the same project as cluster. If this VPC network is under a - different project, vpc-project and vpc-service-account are required. + different project, vpc-project is required. OPTIONAL FLAGS --async diff --git a/gcloud/firestore/export b/gcloud/firestore/export index 75306c1c2..f61081cce 100644 --- a/gcloud/firestore/export +++ b/gcloud/firestore/export @@ -46,11 +46,10 @@ FLAGS complete. --collection-ids=[COLLECTION_IDS,...] - A list specifying which collections will be included in the operation. + List specifying which collections will be included in the operation. When omitted, all collections are included. - For example, to operate on only the 'customers' and 'orders' - collections: + For example, to operate on only the customers and orders collections: $ gcloud firestore export --collection-ids='customers','orders' @@ -62,13 +61,12 @@ FLAGS $ gcloud firestore export --database='foo' --namespace-ids=[NAMESPACE_IDS,...] - A list specifying which namespaces will be included in the operation. + List specifying which namespaces will be included in the operation. When omitted, all namespaces are included. This is only supported for Datastore Mode databases. - For example, to operate on only the 'customers' and 'orders' - namespaces: + For example, to operate on only the customers and orders namespaces: $ gcloud firestore export --namespaces-ids='customers','orders' diff --git a/gcloud/firestore/import b/gcloud/firestore/import index d0adb39ef..7643e31d5 100644 --- a/gcloud/firestore/import +++ b/gcloud/firestore/import @@ -41,11 +41,10 @@ FLAGS complete. --collection-ids=[COLLECTION_IDS,...] - A list specifying which collections will be included in the operation. + List specifying which collections will be included in the operation. When omitted, all collections are included. - For example, to operate on only the 'customers' and 'orders' - collections: + For example, to operate on only the customers and orders collections: $ gcloud firestore import --collection-ids='customers','orders' @@ -57,13 +56,12 @@ FLAGS $ gcloud firestore import --database='foo' --namespace-ids=[NAMESPACE_IDS,...] - A list specifying which namespaces will be included in the operation. + List specifying which namespaces will be included in the operation. When omitted, all namespaces are included. This is only supported for Datastore Mode databases. - For example, to operate on only the 'customers' and 'orders' - namespaces: + For example, to operate on only the customers and orders namespaces: $ gcloud firestore import --namespaces-ids='customers','orders' diff --git a/gcloud/firestore/operations/cancel b/gcloud/firestore/operations/cancel index 38e1ca39c..d55405cf7 100644 --- a/gcloud/firestore/operations/cancel +++ b/gcloud/firestore/operations/cancel @@ -3,7 +3,8 @@ NAME Firestore admin operation SYNOPSIS - gcloud firestore operations cancel NAME [GCLOUD_WIDE_FLAG ...] + gcloud firestore operations cancel NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Cancel a currently-running Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud firestore operations cancel --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firestore/operations/delete b/gcloud/firestore/operations/delete index fcc26044e..4a14609ab 100644 --- a/gcloud/firestore/operations/delete +++ b/gcloud/firestore/operations/delete @@ -3,7 +3,8 @@ NAME admin operation SYNOPSIS - gcloud firestore operations delete NAME [GCLOUD_WIDE_FLAG ...] + gcloud firestore operations delete NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Delete a completed Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud firestore operations delete --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firestore/operations/describe b/gcloud/firestore/operations/describe index a7c66106b..cebdae44e 100644 --- a/gcloud/firestore/operations/describe +++ b/gcloud/firestore/operations/describe @@ -3,7 +3,8 @@ NAME Firestore admin operation SYNOPSIS - gcloud firestore operations describe NAME [GCLOUD_WIDE_FLAG ...] + gcloud firestore operations describe NAME + [--database=DATABASE; default="(default)"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Retrieves information about a Cloud Firestore admin operation. @@ -24,6 +25,14 @@ POSITIONAL ARGUMENTS foo +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud firestore operations describe --database='foo' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firestore/operations/list b/gcloud/firestore/operations/list index cbf63ab40..32a90d41e 100644 --- a/gcloud/firestore/operations/list +++ b/gcloud/firestore/operations/list @@ -3,9 +3,10 @@ NAME operations and their status SYNOPSIS - gcloud firestore operations list [--filter=EXPRESSION] - [--limit=LIMIT; default=100] [--page-size=PAGE_SIZE; default=100] - [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + gcloud firestore operations list [--database=DATABASE; default="(default)"] + [--filter=EXPRESSION] [--limit=LIMIT; default=100] + [--page-size=PAGE_SIZE; default=100] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Filters are case-sensitive and have the following syntax: @@ -24,6 +25,14 @@ EXAMPLES $ gcloud firestore operations list --filter="done:true" +FLAGS + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud firestore operations list --database='foo' + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/metastore/services/export/gcs b/gcloud/metastore/services/export/gcs index 9ca8e258e..ec43c96ce 100644 --- a/gcloud/metastore/services/export/gcs +++ b/gcloud/metastore/services/export/gcs @@ -69,7 +69,10 @@ OPTIONAL FLAGS --dump-type=DUMP_TYPE; default="mysql" The type of the database dump. If unspecified, defaults to mysql. - DUMP_TYPE must be (currently only one value is supported): + DUMP_TYPE must be one of: + + avro + Database dump contains AVRO files. mysql Database dump is a MYSQL dump file. diff --git a/gcloud/metastore/services/import/gcs b/gcloud/metastore/services/import/gcs index ebe1d7fa7..05e0b34af 100644 --- a/gcloud/metastore/services/import/gcs +++ b/gcloud/metastore/services/import/gcs @@ -76,7 +76,10 @@ OPTIONAL FLAGS --dump-type=DUMP_TYPE; default="mysql" The type of the database dump;. If unspecified, defaults to mysql. - DUMP_TYPE must be (currently only one value is supported): + DUMP_TYPE must be one of: + + avro + Database dump contains AVRO files. mysql Database dump is a MYSQL dump file. diff --git a/gcloud/org-policies/set-policy b/gcloud/org-policies/set-policy index 955d49a88..1894b214c 100644 --- a/gcloud/org-policies/set-policy +++ b/gcloud/org-policies/set-policy @@ -3,7 +3,8 @@ NAME YAML file SYNOPSIS - gcloud org-policies set-policy POLICY_FILE [GCLOUD_WIDE_FLAG ...] + gcloud org-policies set-policy POLICY_FILE [--update-mask=UPDATE_MASK] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Sets an organization policy from a JSON or YAML file. The policy will be @@ -18,6 +19,13 @@ POSITIONAL ARGUMENTS POLICY_FILE Path to JSON or YAML file that contains the organization policy. +FLAGS + --update-mask=UPDATE_MASK + Field mask used to specify the fields to be overwritten in the policy + by the set. The fields specified in the update_mask are relative to the + policy, not the full request. The update-mask flag can be empty, or + have values policy.spec, policy.dry_run_spec or * + 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/privateca/roots/create b/gcloud/privateca/roots/create index a87cb57c8..ec6202722 100644 --- a/gcloud/privateca/roots/create +++ b/gcloud/privateca/roots/create @@ -18,6 +18,11 @@ SYNOPSIS --key-usages=[KEY_USAGES,...] --max-chain-length=MAX_CHAIN_LENGTH | --unconstrained-chain-length] [GCLOUD_WIDE_FLAG ...] +DESCRIPTION + TIP: Consider setting a project lien + (https://cloud.google.com/resource-manager/docs/project-liens) on the + project to prevent it from accidental deletion. + EXAMPLES To create a root CA that supports one layer of subordinates: diff --git a/gcloud/pubsub/schemas/commit b/gcloud/pubsub/schemas/commit new file mode 100644 index 000000000..f6957dd6f --- /dev/null +++ b/gcloud/pubsub/schemas/commit @@ -0,0 +1,70 @@ +NAME + gcloud pubsub schemas commit - commit a Pub/Sub schema revision + +SYNOPSIS + gcloud pubsub schemas commit SCHEMA --type=TYPE + (--definition=DEFINITION | --definition-file=DEFINITION_FILE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commit a Pub/Sub schema revision. + +EXAMPLES + To commit a PROTOCOL_BUFFER schema revision called "key-schema" that + requires exactly one-string field named "key", run: + + $ gcloud pubsub schemas commit key-schema \ + --definition="syntax = 'proto3'; message Message { optional \ + string key = 1; }" --type=protocol-buffer To commit an equivalent \ + AVRO schema revision, run: + + $ gcloud pubsub schemas commit key-schema \ + --definition="{ 'type': 'record', 'namespace': 'my.ns', 'name': \ + 'KeyMsg', 'fields': [ { 'name': 'key', 'type': 'string' } ] }" \ + --type=avro + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema to revise. 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +REQUIRED FLAGS + --type=TYPE + The type of the schema. + + Schema definition + + Exactly one of these must be specified: + + --definition=DEFINITION + The new definition of the schema. + + --definition-file=DEFINITION_FILE + File containing the new schema definition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --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 pubsub schemas commit + + $ gcloud beta pubsub schemas commit + diff --git a/gcloud/pubsub/schemas/delete-revision b/gcloud/pubsub/schemas/delete-revision new file mode 100644 index 000000000..1955b3763 --- /dev/null +++ b/gcloud/pubsub/schemas/delete-revision @@ -0,0 +1,46 @@ +NAME + gcloud pubsub schemas delete-revision - delete a Pub/Sub schema revision + +SYNOPSIS + gcloud pubsub schemas delete-revision SCHEMA [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Pub/Sub schema revision. + +EXAMPLES + To roll back to an existing schema revision called "key-schema" with + revision_id: "0a0b0c0d", run: + + $ gcloud pubsub schemas delete-revision key-schema@0a0b0c0d + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema revision to delete. This represents a + Cloud resource. (NOTE) Some attributes are not given arguments in this + group but can be set in other ways. To set the project attribute: + ◆ provide the argument schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha pubsub schemas delete-revision + + $ gcloud beta pubsub schemas delete-revision + diff --git a/gcloud/pubsub/schemas/help b/gcloud/pubsub/schemas/help index 66d435396..d28fba891 100644 --- a/gcloud/pubsub/schemas/help +++ b/gcloud/pubsub/schemas/help @@ -18,18 +18,30 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + commit + Commit a Pub/Sub schema revision. + create Create a Pub/Sub schema. delete Delete a Pub/Sub schema. + delete-revision + Delete a Pub/Sub schema revision. + describe Show details of a Pub/Sub schema. list List Pub/Sub schemas. + list-revisions + List revisions of a Pub/Sub schema. + + rollback + Roll back a Pub/Sub schema to a specified revision. + validate-message Validate a message against a Pub/Sub schema. diff --git a/gcloud/pubsub/schemas/list-revisions b/gcloud/pubsub/schemas/list-revisions new file mode 100644 index 000000000..1d5652d07 --- /dev/null +++ b/gcloud/pubsub/schemas/list-revisions @@ -0,0 +1,95 @@ +NAME + gcloud pubsub schemas list-revisions - list revisions of a Pub/Sub schema + +SYNOPSIS + gcloud pubsub schemas list-revisions SCHEMA [--view=VIEW; default="basic"] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List revisions of a Pub/Sub schema. + +EXAMPLES + To list the revisions for a schema, run: + + $ gcloud pubsub schemas list-revisions my-schema + +POSITIONAL ARGUMENTS + Schema resource - Parent Pub/Sub schema to list all contained revisions. + 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +FLAGS + --view=VIEW; default="basic" + There are two possible views, 'basic' and 'full', default is 'basic'. + VIEW must be one of: + + basic + Include the name and type of the schema, but not the definition. + + full + Include all Schema object fields. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the pubsub/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/pubsub/docs + +NOTES + These variants are also available: + + $ gcloud alpha pubsub schemas list-revisions + + $ gcloud beta pubsub schemas list-revisions + diff --git a/gcloud/pubsub/schemas/rollback b/gcloud/pubsub/schemas/rollback new file mode 100644 index 000000000..840b76ff6 --- /dev/null +++ b/gcloud/pubsub/schemas/rollback @@ -0,0 +1,52 @@ +NAME + gcloud pubsub schemas rollback - roll back a Pub/Sub schema to a specified + revision + +SYNOPSIS + gcloud pubsub schemas rollback SCHEMA --revision-id=REVISION_ID + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Roll back a Pub/Sub schema to a specified revision. + +EXAMPLES + To roll back to an existing schema revision called "key-schema" with + revision_id: "0a0b0c0d", run: + + $ gcloud pubsub schemas rollback key-schema --revision-id=0a0b0c0d + +POSITIONAL ARGUMENTS + Schema resource - Name of the schema to rollback. 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 schema 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. + + SCHEMA + ID of the schema or fully qualified identifier for the schema. To set + the schema attribute: + ▸ provide the argument schema on the command line. + +REQUIRED FLAGS + --revision-id=REVISION_ID + The revision to roll back to. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha pubsub schemas rollback + + $ gcloud beta pubsub schemas rollback + diff --git a/gcloud/pubsub/topics/create b/gcloud/pubsub/topics/create index 059452cbe..772ad0fc6 100644 --- a/gcloud/pubsub/topics/create +++ b/gcloud/pubsub/topics/create @@ -6,7 +6,9 @@ SYNOPSIS [--message-retention-duration=MESSAGE_RETENTION_DURATION] [--message-storage-policy-allowed-regions=[REGION,...]] [--message-encoding=ENCODING (--schema=SCHEMA - : --schema-project=SCHEMA_PROJECT)] + : --schema-project=SCHEMA_PROJECT) + : --first-revision-id=FIRST_REVISION_ID + --last-revision-id=LAST_REVISION_ID] [--topic-encryption-key=TOPIC_ENCRYPTION_KEY : --topic-encryption-key-keyring=TOPIC_ENCRYPTION_KEY_KEYRING --topic-encryption-key-location=TOPIC_ENCRYPTION_KEY_LOCATION @@ -72,6 +74,12 @@ FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --first-revision-id=FIRST_REVISION_ID + The id of the oldest revision allowed for the specified schema. + + --last-revision-id=LAST_REVISION_ID + The id of the most recent revision allowed for the specified schema + Schema resource - Name of the schema that messages published to this topic must conform to. The arguments in this group can be used to specify the attributes of this resource. diff --git a/gcloud/pubsub/topics/update b/gcloud/pubsub/topics/update index 1dde18c1a..3090253bc 100644 --- a/gcloud/pubsub/topics/update +++ b/gcloud/pubsub/topics/update @@ -6,6 +6,11 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [--clear-message-retention-duration | --message-retention-duration=MESSAGE_RETENTION_DURATION] + [--clear-schema-settings + | [--message-encoding=ENCODING (--schema=SCHEMA + : --schema-project=SCHEMA_PROJECT) + : --first-revision-id=FIRST_REVISION_ID + --last-revision-id=LAST_REVISION_ID]] [--message-storage-policy-allowed-regions=[REGION,...] | --recompute-message-storage-policy] [--topic-encryption-key=TOPIC_ENCRYPTION_KEY @@ -124,6 +129,50 @@ FLAGS seconds, minutes, hours, and days, respectively. If the unit is omitted, seconds is assumed. + At most one of these can be specified: + + --clear-schema-settings + If set, clear the Schema Settings from the topic. + + Schema settings. The schema that messages published to this topic must + conform to and the expected message encoding. + + --message-encoding=ENCODING + The encoding of messages validated against the schema. ENCODING + must be one of: json, binary. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --first-revision-id=FIRST_REVISION_ID + The id of the oldest revision allowed for the specified schema. + + --last-revision-id=LAST_REVISION_ID + The id of the most recent revision allowed for the specified schema + + Schema resource - Name of the schema that messages published to this + topic must conform to. The arguments in this group can be used to + specify the attributes of this resource. + + This must be specified. + + --schema=SCHEMA + ID of the schema or fully qualified identifier for the schema. To + set the schema attribute: + ◇ provide the argument --schema on the command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --schema-project=SCHEMA_PROJECT + Project ID of the Google Cloud project for the schema. To set the + project attribute: + ◇ provide the argument --schema on the command line with a + fully specified name; + ◇ provide the argument --schema-project on the command line; + ◇ provide the argument --project on the command line; + ◇ set the property core/project. + Message storage policy options. At most one of these can be specified: diff --git a/gcloud/recommender/recommendations/help b/gcloud/recommender/recommendations/help index ec3bb1947..eb102c767 100644 --- a/gcloud/recommender/recommendations/help +++ b/gcloud/recommender/recommendations/help @@ -24,6 +24,9 @@ COMMANDS mark-claimed Mark a recommendation's state as CLAIMED. + mark-dismissed + Mark recommendation's state as DISMISSED. + mark-failed Mark a recommendation's state as FAILED. diff --git a/gcloud/recommender/recommendations/mark-dismissed b/gcloud/recommender/recommendations/mark-dismissed new file mode 100644 index 000000000..97a429206 --- /dev/null +++ b/gcloud/recommender/recommendations/mark-dismissed @@ -0,0 +1,74 @@ +NAME + gcloud recommender recommendations mark-dismissed - mark recommendation's + state as DISMISSED + +SYNOPSIS + gcloud recommender recommendations mark-dismissed RECOMMENDATION + --etag=ETAG --location=LOCATION --recommender=RECOMMENDER + (--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID + | --organization=ORGANIZATION_ID | --project=PROJECT_ID) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Mark recommendation's state as DISMISSED. Can be applied to recommendations + in ACTIVE state. The following parent resources are supported: project, + billing account, folder, and organization as parent resources for + recommendations. + +EXAMPLES + To mark a recommendation as DISMISSED: + + $ gcloud recommender recommendations mark-dismissed abcd-1234 \ + --project=project-name --location=global \ + --recommender=google.compute.instance.MachineTypeRecommender \ + --etag=abc123 + +POSITIONAL ARGUMENTS + RECOMMENDATION + Recommendation ID which will be marked as dismissed + +REQUIRED FLAGS + --etag=ETAG + Etag of a recommendation + + --location=LOCATION + Location + + --recommender=RECOMMENDER + Recommender of the recommendations + + Resource that is associated with cloud entity type. Currently four + mutually exclusive flags are supported, --project, --billing-account, + --folder, --organization. + + Exactly one of these must be specified: + + --billing-account=BILLING_ACCOUNT + The Google Cloud Platform billing account ID to use for this + invocation. + + --folder=FOLDER_ID + The Google Cloud Platform folder ID to use for this invocation. + + --organization=ORGANIZATION_ID + The Google Cloud Platform organization ID to use for this invocation. + + --project=PROJECT_ID + The Google Cloud Platform project ID. Overrides the default + core/project property value for this command invocation. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha recommender recommendations mark-dismissed + + $ gcloud beta recommender recommendations mark-dismissed + diff --git a/gcloud/sql/users/create b/gcloud/sql/users/create index 65e9a5a9e..0056c357a 100644 --- a/gcloud/sql/users/create +++ b/gcloud/sql/users/create @@ -28,13 +28,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). --password=PASSWORD Cloud SQL user's password. diff --git a/gcloud/sql/users/delete b/gcloud/sql/users/delete index 036dba49a..889f92c10 100644 --- a/gcloud/sql/users/delete +++ b/gcloud/sql/users/delete @@ -23,13 +23,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/sql/users/set-password b/gcloud/sql/users/set-password index da2039d0f..8b41c4ec5 100644 --- a/gcloud/sql/users/set-password +++ b/gcloud/sql/users/set-password @@ -25,13 +25,13 @@ OPTIONAL FLAGS complete. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). At most one of these can be specified: diff --git a/gcloud/sql/users/set-password-policy b/gcloud/sql/users/set-password-policy index 9e9444264..3c341215e 100644 --- a/gcloud/sql/users/set-password-policy +++ b/gcloud/sql/users/set-password-policy @@ -47,13 +47,13 @@ OPTIONAL FLAGS Postgres. --host=HOST - Cloud SQL user's host name expressed as a specific IP address or - address range. % denotes an unrestricted host name. Applicable flag for - MySQL instances; ignored for all other engines. Note, if you connect to - your instance using IP addresses, you must add your client IP address - as an Authorized Address, even if your host name is unrestricted. For - help on how to do so, read: - https://cloud.google.com/sql/docs/mysql/configure-ip + Cloud SQL user's hostname expressed as a specific IP address or address + range. % denotes an unrestricted hostname. Applicable flag for MySQL + instances; ignored for all other engines. Note, if you connect to your + instance using IP addresses, you must add your client IP address as an + authorized address, even if your hostname is unrestricted. For more + information, see Configure IP + (https://cloud.google.com/sql/docs/mysql/configure-ip). --password-policy-allowed-failed-attempts=PASSWORD_POLICY_ALLOWED_FAILED_ATTEMPTS Number of failed login attempts allowed before a user is locked out.