imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00
Code Activity

gcloud: Wed Oct 5 10:40:53 UTC 2022

Browse source
This commit is contained in:
Automated 2022-10-05 10:40:53 +00:00
parent ffb9e43995
commit 344952a6dd
Failed to extract signature
135 changed files with 3530 additions and 534 deletions
Download patch file Download diff file Expand all files Collapse all files

177
gcloud/alpha/spanner/instance-configs/create Normal file
View file

@ -0,0 +1,177 @@
NAME
gcloud alpha spanner instance-configs create - create a Cloud Spanner
instance configuration
SYNOPSIS
gcloud alpha spanner instance-configs create INSTANCE_CONFIG
(--base-config=BASE_CONFIG --replicas=location=LOCATION,type=TYPE:[...]
| [--clone-config=INSTANCE_CONFIG
: --add-replicas=location=LOCATION,type=TYPE:[...]
--skip-replicas=location=LOCATION,type=TYPE:[...]]) [--async]
[--display-name=DISPLAY_NAME] [--etag=ETAG] [--labels=[KEY=VALUE,...]]
[--validate-only] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a Cloud Spanner instance configuration.
EXAMPLES
To create a custom Cloud Spanner instance configuration, run:
$ gcloud alpha spanner instance-configs create \
custom-instance-config \
--display-name=custom-instance-config-name --base-config=nam3 \
--replicas=location=us-east4,type=READ_WRITE:location=us-east4,\
type=READ_WRITE:location=us-east1,\
type=READ_WRITE:location=us-east1,\
type=READ_WRITE:location=us-central1,type=WITNESS
To create a custom Cloud Spanner instance configuration based on an
existing Google-managed configuration (nam3) by adding a 'READ_ONLY' type
replica in location 'us-east4', run:
$ gcloud alpha spanner instance-configs create \
custom-instance-config --clone-config=nam3 \
--add-replicas=location=us-east4,type=READ_ONLY
To create a custom Cloud Spanner instance configuration based on an
existing Google-managed configuration (nam3) by adding a 'READ_ONLY' type
replica in location 'us-east4' and removing a 'READ_ONLY' type replica in
location 'us-central1', run:
$ gcloud alpha spanner instance-configs create \
custom-instance-config --clone-config=nam3 \
--add-replicas=location=us-east4,type=READ_ONLY \
--skip-replicas=location=us-central1,type=READ_ONLY
POSITIONAL ARGUMENTS
INSTANCE_CONFIG
Cloud Spanner instance configuration. The 'custom-' prefix is required
to avoid name conflicts with Google-managed configurations.
REQUIRED FLAGS
Exactly one of these must be specified:
Command-line flags to setup a custom instance configuration replicas:
--base-config=BASE_CONFIG
The name of the Google-managed instance configuration, based on
which your custom configuration is created.
This flag argument must be specified if any of the other arguments
in this group are specified.
--replicas=location=LOCATION,type=TYPE:[...]
The geographic placement of nodes in this instance configuration
and their replication types.
location
The location of the serving resources, e.g. "us-central1".
type
The type of replica.
Items in the list are separated by ":". The allowed values and
formats are as follows.
READ_ONLY
Read-only replicas only support reads (not writes). Read-only
replicas:
▫ Maintain a full copy of your data.
▫ Serve reads.
▫ Do not participate in voting to commit writes.
▫ Are not eligible to become a leader.
READ_WRITE
Read-write replicas support both reads and writes. These replicas:
▫ Maintain a full copy of your data.
▫ Serve reads.
▫ Can vote whether to commit a write.
▫ Participate in leadership election.
▫ Are eligible to become a leader.
WITNESS
Witness replicas don't support reads but do participate in voting
to commit writes. Witness replicas:
▫ Do not maintain a full copy of data.
▫ Do not serve reads.
▫ Vote whether to commit writes.
▫ Participate in leader election but are not eligible to become
leader.
This flag argument must be specified if any of the other arguments
in this group are specified.
Command-line flags to setup a custom instance configuration using clone
options:
--clone-config=INSTANCE_CONFIG
The ID of the instance config, based on which this configuration is
created. The clone is an independent copy of this config. Available
configurations can be found by running "gcloud spanner
instance-configs list"
This flag argument must be specified if any of the other arguments
in this group are specified.
--add-replicas=location=LOCATION,type=TYPE:[...]
Add new replicas while cloning from the source config.
--skip-replicas=location=LOCATION,type=TYPE:[...]
Skip replicas from the source config while cloning. Each replica in
the list must exist in the source config replicas list.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--display-name=DISPLAY_NAME
The name of this instance configuration as it appears in UIs. Must
specify this option if creating an instance-config with --replicas.
--etag=ETAG
Used for optimistic concurrency control.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--validate-only
Use this flag to validate that the request will succeed before
executing it.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud spanner instance-configs create
$ gcloud beta spanner instance-configs create

47
gcloud/alpha/spanner/instance-configs/delete Normal file
View file

@ -0,0 +1,47 @@
NAME
gcloud alpha spanner instance-configs delete - delete a Cloud Spanner
instance configuration
SYNOPSIS
gcloud alpha spanner instance-configs delete INSTANCE_CONFIG [--etag=ETAG]
[--validate-only] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a Cloud Spanner instance configuration.
EXAMPLES
To delete a custom Cloud Spanner instance configuration, run:
$ gcloud alpha spanner instance-configs delete custom-instance-config
POSITIONAL ARGUMENTS
INSTANCE_CONFIG
Cloud Spanner instance config.
FLAGS
--etag=ETAG
Used for optimistic concurrency control as a way to help prevent
simultaneous deletes of an instance config from overwriting each other.
--validate-only
Use this flag to validate that the request will succeed before
executing it.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud spanner instance-configs delete
$ gcloud beta spanner instance-configs delete

4
gcloud/alpha/spanner/instance-configs/describe
View file

@ -1,13 +1,13 @@
NAME
gcloud alpha spanner instance-configs describe - describe a Cloud Spanner
instance config
instance configuration
SYNOPSIS
gcloud alpha spanner instance-configs describe INSTANCE_CONFIG
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a Cloud Spanner instance config.
(ALPHA) Describe a Cloud Spanner instance configuration.
EXAMPLES
To describe an instance config named regional-us-central1, run:

13
gcloud/alpha/spanner/instance-configs/help
View file

@ -16,11 +16,20 @@ GCLOUD WIDE FLAGS
COMMANDS
COMMAND is one of the following:
create
(ALPHA) Create a Cloud Spanner instance configuration.
delete
(ALPHA) Delete a Cloud Spanner instance configuration.
describe
(ALPHA) Describe a Cloud Spanner instance config.
(ALPHA) Describe a Cloud Spanner instance configuration.
list
(ALPHA) List the available Cloud Spanner instance configs.
(ALPHA) List the available Cloud Spanner instance configurations.
update
(ALPHA) Update a Cloud Spanner instance configuration.
NOTES
This command is currently in alpha and might change without notice. If this

4
gcloud/alpha/spanner/instance-configs/list
View file

@ -1,6 +1,6 @@
NAME
gcloud alpha spanner instance-configs list - list the available Cloud
Spanner instance configs
Spanner instance configurations
SYNOPSIS
gcloud alpha spanner instance-configs list [--filter=EXPRESSION]
@ -8,7 +8,7 @@ SYNOPSIS
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List the available Cloud Spanner instance configs.
(ALPHA) List the available Cloud Spanner instance configurations.
EXAMPLES
To list the Cloud Spanner instance configs that are availble for this

107
gcloud/alpha/spanner/instance-configs/update Normal file
View file

@ -0,0 +1,107 @@
NAME
gcloud alpha spanner instance-configs update - update a Cloud Spanner
instance configuration
SYNOPSIS
gcloud alpha spanner instance-configs update INSTANCE_CONFIG [--async]
[--display-name=DISPLAY_NAME] [--etag=ETAG]
[--update-labels=[KEY=VALUE,...]] [--validate-only]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update a Cloud Spanner instance configuration.
EXAMPLES
To update display name of a custom Cloud Spanner instance configuration
'custom-instance-config', run:
$ gcloud alpha spanner instance-configs update \
custom-instance-config --display-name=nam3-RO-us-central1
To modify the instance config 'custom-instance-config' by adding label
'k0', with value 'value1' and label 'k1' with value 'value2' and removing
labels with key 'k3', run:
$ gcloud alpha spanner instance-configs update \
custom-instance-config --update-labels=k0=value1,k1=value2 \
--remove-labels=k3
To clear all labels of a custom Cloud Spanner instance configuration
'custom-instance-config', run:
$ gcloud alpha spanner instance-configs update \
custom-instance-config --clear-labels
To remove an existing label of a custom Cloud Spanner instance
configuration 'custom-instance-config', run:
$ gcloud alpha spanner instance-configs update \
custom-instance-config --remove-labels=KEY1,KEY2
POSITIONAL ARGUMENTS
INSTANCE_CONFIG
Cloud Spanner instance config. The 'custom-' prefix is required to
avoid name conflicts with Google-managed configurations.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--display-name=DISPLAY_NAME
The name of this instance configuration as it appears in UIs.
--etag=ETAG
Used for optimistic concurrency control.
--update-labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to update. If a label exists, its value
is modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
--validate-only
Use this flag to validate that the request will succeed before
executing it.
At most one of these can be specified:
--clear-labels
Remove all labels. If --update-labels is also specified then
--clear-labels is applied first.
For example, to remove all labels:
$ gcloud alpha spanner instance-configs update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud alpha spanner instance-configs update --clear-labels \
--update-labels foo=bar,baz=qux
--remove-labels=[KEY,...]
List of label keys to remove. If a label does not exist it is
silently ignored. If --update-labels is also specified then
--update-labels is applied first.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
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 spanner instance-configs update
$ gcloud beta spanner instance-configs update