mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-15 17:35:31 +00:00
gcloud: Wed Jul 13 09:59:37 UTC 2022
This commit is contained in:
parent
cf5ab60e4a
commit
879929cbc6
323 changed files with 7203 additions and 4178 deletions
63
gcloud/alpha/spanner/samples/backend
Normal file
63
gcloud/alpha/spanner/samples/backend
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
NAME
|
||||
gcloud alpha spanner samples backend - run the backend gRPC service for the
|
||||
given Cloud Spanner sample app
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha spanner samples backend APPNAME --instance-id=INSTANCE_ID
|
||||
[--database-id=DATABASE_ID] [--duration=DURATION; default="1h"]
|
||||
[--port=PORT] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) 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 alpha spanner samples init APPNAME --instance-id=INSTANCE_ID
|
||||
|
||||
After starting the service, generate traffic with:
|
||||
|
||||
$ gcloud alpha spanner samples workload APPNAME
|
||||
|
||||
To run all three steps together, use:
|
||||
|
||||
$ gcloud alpha 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 alpha 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 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.
|
||||
|
||||
48
gcloud/alpha/spanner/samples/help
Normal file
48
gcloud/alpha/spanner/samples/help
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
NAME
|
||||
gcloud alpha spanner samples - cloud Spanner sample apps
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha spanner samples COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) 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
|
||||
(ALPHA) Run the backend gRPC service for the given Cloud Spanner sample
|
||||
app.
|
||||
|
||||
init
|
||||
(ALPHA) Initialize a Cloud Spanner sample app.
|
||||
|
||||
list
|
||||
(ALPHA) List available sample applications.
|
||||
|
||||
run
|
||||
(ALPHA) Run the given Cloud Spanner sample app.
|
||||
|
||||
workload
|
||||
(ALPHA) Generate gRPC traffic for a given sample app's backend service.
|
||||
|
||||
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.
|
||||
|
||||
42
gcloud/alpha/spanner/samples/init
Normal file
42
gcloud/alpha/spanner/samples/init
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
NAME
|
||||
gcloud alpha spanner samples init - initialize a Cloud Spanner sample app
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha spanner samples init APPNAME --instance-id=INSTANCE_ID
|
||||
[--database-id=DATABASE_ID] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) 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 alpha 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 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.
|
||||
|
||||
57
gcloud/alpha/spanner/samples/list
Normal file
57
gcloud/alpha/spanner/samples/list
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
NAME
|
||||
gcloud alpha spanner samples list - list available sample applications
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha spanner samples list [--filter=EXPRESSION] [--limit=LIMIT]
|
||||
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) List available sample applications.
|
||||
|
||||
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 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.
|
||||
|
||||
60
gcloud/alpha/spanner/samples/run
Normal file
60
gcloud/alpha/spanner/samples/run
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
NAME
|
||||
gcloud alpha spanner samples run - run the given Cloud Spanner sample app
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha spanner samples run APPNAME --instance-id=INSTANCE_ID
|
||||
[--no-cleanup] [--database-id=DATABASE_ID]
|
||||
[--duration=DURATION; default="1h"] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) 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 alpha spanner samples list
|
||||
|
||||
EXAMPLES
|
||||
To run the 'finance' sample app using instance 'my-instance', run:
|
||||
|
||||
$ gcloud alpha 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 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.
|
||||
|
||||
54
gcloud/alpha/spanner/samples/workload
Normal file
54
gcloud/alpha/spanner/samples/workload
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
NAME
|
||||
gcloud alpha spanner samples workload - generate gRPC traffic for a given
|
||||
sample app's backend service
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha spanner samples workload APPNAME
|
||||
[--duration=DURATION; default="1h"] [--port=PORT]
|
||||
[--target-qps=TARGET_QPS] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Before sending traffic to the backend service, create the database
|
||||
and start the service with:
|
||||
|
||||
$ gcloud alpha spanner samples init APPNAME --instance-id=INSTANCE_ID
|
||||
$ gcloud alpha spanner samples backend APPNAME \
|
||||
--instance-id=INSTANCE_ID
|
||||
|
||||
To run all three steps together, use:
|
||||
|
||||
$ gcloud alpha spanner samples run APPNAME --instance-id=INSTANCE_ID
|
||||
|
||||
EXAMPLES
|
||||
To generate traffic for the 'finance' sample app, run:
|
||||
|
||||
$ gcloud alpha 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 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.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue