1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 06:47:12 +00:00

gcloud: Wed Aug 24 09:45:53 UTC 2022

This commit is contained in:
Automated 2022-08-24 09:45:53 +00:00
parent c614d893da
commit 978ed239f6
Failed to extract signature
127 changed files with 2957 additions and 251 deletions

View file

@ -33,6 +33,9 @@ GROUPS
rows
(BETA) Manage the rows in Cloud Spanner databases.
samples
(BETA) Cloud Spanner sample apps.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:

View file

@ -3,8 +3,9 @@ NAME
SYNOPSIS
gcloud beta spanner instances create INSTANCE --config=CONFIG
--description=DESCRIPTION
(--nodes=NODES | --processing-units=PROCESSING_UNITS) [--async]
--description=DESCRIPTION [--async] [--expire-behavior=EXPIRE_BEHAVIOR]
[--instance-type=INSTANCE_TYPE]
[--nodes=NODES | --processing-units=PROCESSING_UNITS]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
@ -30,7 +31,35 @@ REQUIRED FLAGS
--description=DESCRIPTION
Description of the instance.
Exactly one of these must be specified:
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--expire-behavior=EXPIRE_BEHAVIOR
The expire behavior of a free trial instance. EXPIRE_BEHAVIOR must be
one of:
free-to-provisioned
When the free trial instance expires, upgrade the instance to a
provisioned instance.
remove-after-grace-period
When the free trial instance expires, disable the instance, and
delete it after the grace period passes if it has not been upgraded
to a provisioned instance.
--instance-type=INSTANCE_TYPE
Specifies the type for this instance. INSTANCE_TYPE must be one of:
free-instance
Free trial instances provide no guarantees for dedicated resources,
both node_count and processing_units should be 0. They come with
stricter usage limits and limited support.
provisioned
Provisioned instances have dedicated resources, standard usage
limits, and support.
At most one of these can be specified:
--nodes=NODES
Number of nodes for the instance.
@ -38,11 +67,6 @@ REQUIRED FLAGS
--processing-units=PROCESSING_UNITS
Number of processing units for the instance.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -3,7 +3,8 @@ NAME
SYNOPSIS
gcloud beta spanner instances update INSTANCE [--async]
[--description=DESCRIPTION]
[--description=DESCRIPTION] [--expire-behavior=EXPIRE_BEHAVIOR]
[--instance-type=INSTANCE_TYPE]
[--nodes=NODES | --processing-units=PROCESSING_UNITS]
[GCLOUD_WIDE_FLAG ...]
@ -32,6 +33,29 @@ FLAGS
--description=DESCRIPTION
Description of the instance.
--expire-behavior=EXPIRE_BEHAVIOR
The expire behavior of a free trial instance. EXPIRE_BEHAVIOR must be
one of:
free-to-provisioned
When the free trial instance expires, upgrade the instance to a
provisioned instance.
remove-after-grace-period
When the free trial instance expires, disable the instance, and
delete it after the grace period passes if it has not been upgraded
to a provisioned instance.
--instance-type=INSTANCE_TYPE
Specifies the type for this instance. INSTANCE_TYPE must be one of:
free-instance
Free trial instances provide no guarantees for dedicated resources,
both node_count and processing_units should be 0. They come with
stricter usage limits and limited support.
provisioned
Provisioned instances have dedicated resources, standard usage
limits, and support.
At most one of these can be specified:
--nodes=NODES

View file

@ -0,0 +1,65 @@
NAME
gcloud beta spanner samples backend - run the backend gRPC service for the
given Cloud Spanner sample app
SYNOPSIS
gcloud beta spanner samples backend APPNAME --instance-id=INSTANCE_ID
[--database-id=DATABASE_ID] [--duration=DURATION; default="1h"]
[--port=PORT] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command starts the backend gRPC service for the given sample
application. Before starting the service, create the database and load any
initial data with:
$ gcloud beta spanner samples init APPNAME --instance-id=INSTANCE_ID
After starting the service, generate traffic with:
$ gcloud beta spanner samples workload APPNAME
To run all three steps together, use:
$ gcloud beta spanner samples run APPNAME --instance-id=INSTANCE_ID
EXAMPLES
To run the backend gRPC service for the 'finance' sample app using instance
'my-instance', run:
$ gcloud beta spanner samples backend finance \
--instance-id=my-instance
POSITIONAL ARGUMENTS
APPNAME
The sample app name, e.g. "finance".
REQUIRED FLAGS
--instance-id=INSTANCE_ID
The Cloud Spanner instance ID for the sample app.
OPTIONAL FLAGS
--database-id=DATABASE_ID
The Cloud Spanner database ID for the sample app.
--duration=DURATION; default="1h"
Duration of time allowed to run before stopping the service.
--port=PORT
Port on which to receive gRPC requests.
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 spanner samples backend
$ gcloud alpha spanner samples backend

View file

@ -0,0 +1,50 @@
NAME
gcloud beta spanner samples - cloud Spanner sample apps
SYNOPSIS
gcloud beta spanner samples COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Each Cloud Spanner sample application includes a backend gRPC
service backed by a Cloud Spanner database and a workload script that
generates service traffic.
These sample apps are open source and available at
https://github.com/GoogleCloudPlatform/cloud-spanner-samples.
To see a list of available sample apps, run:
$ gcloud spanner samples list
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
backend
(BETA) Run the backend gRPC service for the given Cloud Spanner sample
app.
init
(BETA) Initialize a Cloud Spanner sample app.
list
(BETA) List available sample applications.
run
(BETA) Run the given Cloud Spanner sample app.
workload
(BETA) Generate gRPC traffic for a given sample app's backend service.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud spanner samples
$ gcloud alpha spanner samples

View file

@ -0,0 +1,44 @@
NAME
gcloud beta spanner samples init - initialize a Cloud Spanner sample app
SYNOPSIS
gcloud beta spanner samples init APPNAME --instance-id=INSTANCE_ID
[--database-id=DATABASE_ID] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command creates a Cloud Spanner database in the given instance
for the sample app and loads any initial data required by the application.
EXAMPLES
To initialize the 'finance' sample app using instance 'my-instance', run:
$ gcloud beta spanner samples init finance --instance-id=my-instance
POSITIONAL ARGUMENTS
APPNAME
The sample app name, e.g. "finance".
REQUIRED FLAGS
--instance-id=INSTANCE_ID
The Cloud Spanner instance ID for the sample app.
OPTIONAL FLAGS
--database-id=DATABASE_ID
ID of the new Cloud Spanner database to create for the sample 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.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud spanner samples init
$ gcloud alpha spanner samples init

View file

@ -0,0 +1,64 @@
NAME
gcloud beta spanner samples list - list available sample applications
SYNOPSIS
gcloud beta spanner samples list [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List available sample applications.
EXAMPLES
To list available sample applications, run:
$ gcloud beta spanner samples 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.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud spanner samples list
$ gcloud alpha spanner samples list

View file

@ -0,0 +1,62 @@
NAME
gcloud beta spanner samples run - run the given Cloud Spanner sample app
SYNOPSIS
gcloud beta spanner samples run APPNAME --instance-id=INSTANCE_ID
[--no-cleanup] [--database-id=DATABASE_ID]
[--duration=DURATION; default="1h"] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Each Cloud Spanner sample application includes a backend gRPC
service backed by a Cloud Spanner database and a workload script that
generates service traffic. This command creates and initializes the Cloud
Spanner database and runs both the backend service and workload script.
These sample apps are open source and available at
https://github.com/GoogleCloudPlatform/cloud-spanner-samples.
To see a list of available sample apps, run:
$ gcloud beta spanner samples list
EXAMPLES
To run the 'finance' sample app using instance 'my-instance', run:
$ gcloud beta spanner samples run finance --instance-id=my-instance
POSITIONAL ARGUMENTS
APPNAME
The sample app name, e.g. "finance".
REQUIRED FLAGS
--instance-id=INSTANCE_ID
The Cloud Spanner instance ID for the sample app.
OPTIONAL FLAGS
--cleanup
Delete the instance after running the sample app. Enabled by default,
use --no-cleanup to disable.
--database-id=DATABASE_ID
ID of the new Cloud Spanner database to create for the sample app.
--duration=DURATION; default="1h"
Duration of time allowed to run the sample app before stopping the
service.
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 spanner samples run
$ gcloud alpha spanner samples run

View file

@ -0,0 +1,56 @@
NAME
gcloud beta spanner samples workload - generate gRPC traffic for a given
sample app's backend service
SYNOPSIS
gcloud beta spanner samples workload APPNAME
[--duration=DURATION; default="1h"] [--port=PORT]
[--target-qps=TARGET_QPS] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Before sending traffic to the backend service, create the database
and start the service with:
$ gcloud beta spanner samples init APPNAME --instance-id=INSTANCE_ID
$ gcloud beta spanner samples backend APPNAME \
--instance-id=INSTANCE_ID
To run all three steps together, use:
$ gcloud beta spanner samples run APPNAME --instance-id=INSTANCE_ID
EXAMPLES
To generate traffic for the 'finance' sample app, run:
$ gcloud beta spanner samples workload finance
POSITIONAL ARGUMENTS
APPNAME
The sample app name, e.g. "finance".
FLAGS
--duration=DURATION; default="1h"
Duration of time allowed to run before stopping the workload.
--port=PORT
Port of the running backend service.
--target-qps=TARGET_QPS
Target requests per second.
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 spanner samples workload
$ gcloud alpha spanner samples workload