mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-18 14:56:05 +00:00
gcloud: Wed Apr 6 08:36:53 UTC 2022
This commit is contained in:
parent
9bf28f1efe
commit
f88a614da8
221 changed files with 7174 additions and 449 deletions
|
|
@ -31,6 +31,9 @@ GROUPS
|
|||
locations
|
||||
(ALPHA) List or Describe Available Cloud TPU Locations.
|
||||
|
||||
queued-resources
|
||||
(ALPHA) List, create, delete, and manage Queued Resources.
|
||||
|
||||
tpu-vm
|
||||
(ALPHA) List, create, and manage Cloud TPU VM nodes.
|
||||
|
||||
|
|
|
|||
86
gcloud/alpha/compute/tpus/queued-resources/create
Normal file
86
gcloud/alpha/compute/tpus/queued-resources/create
Normal file
|
|
@ -0,0 +1,86 @@
|
|||
NAME
|
||||
gcloud alpha compute tpus queued-resources create - create a Queued
|
||||
Resource
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha compute tpus queued-resources create
|
||||
(QUEUED_RESOURCE : --zone=ZONE) [--accelerator-type=ACCELERATOR_TYPE]
|
||||
[--async] [--node-id=NODE_ID] [--runtime-version=RUNTIME_VERSION]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Create a new Queued Resource with the specified attributes.
|
||||
|
||||
EXAMPLES
|
||||
To create a Queued Resource with ID my-queued-resource in zone
|
||||
us-central1-b and project my-project, run:
|
||||
|
||||
$ gcloud alpha compute tpus queued-resources create \
|
||||
my-queued-resource --accelerator-type=v2-8 \
|
||||
--runtime-version=v2-alpha --node-id=my-node-001 \
|
||||
--zone=us-central1-b --project=my-project
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Queued resource resource - The Queued Resource you want 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 queued_resource 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.
|
||||
|
||||
QUEUED_RESOURCE
|
||||
ID of the queued_resource or fully qualified identifier for the
|
||||
queued_resource. To set the queued_resource attribute:
|
||||
▸ provide the argument queued_resource on the command line.
|
||||
|
||||
This positional must be specified if any of the other arguments in
|
||||
this group are specified.
|
||||
|
||||
--zone=ZONE
|
||||
The compute/zone of the Cloud TPU.
|
||||
|
||||
If not specified, will use default compute/zone.
|
||||
|
||||
To set the zone attribute:
|
||||
▸ provide the argument queued_resource on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --zone on the command line;
|
||||
▸ set the property compute/zone.
|
||||
|
||||
FLAGS
|
||||
--accelerator-type=ACCELERATOR_TYPE
|
||||
Accelerator type for the TPU.
|
||||
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
--node-id=NODE_ID
|
||||
The unqualified Node identifier, used to identify the TPU in the Nodes
|
||||
collection once provisioned.
|
||||
|
||||
--runtime-version=RUNTIME_VERSION
|
||||
Runtime version for the TPU, such as 2.3.
|
||||
|
||||
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 tpu/v2alpha1 API. The full documentation for this API
|
||||
can be found at: https://cloud.google.com/tpu/
|
||||
|
||||
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.
|
||||
|
||||
76
gcloud/alpha/compute/tpus/queued-resources/delete
Normal file
76
gcloud/alpha/compute/tpus/queued-resources/delete
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
NAME
|
||||
gcloud alpha compute tpus queued-resources delete - delete a Queued
|
||||
Resource
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha compute tpus queued-resources delete
|
||||
(QUEUED_RESOURCE : --zone=ZONE) [--async] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Delete an existing Queued Resource.
|
||||
|
||||
To get a list of Queued Resources for deletion, run:
|
||||
|
||||
$ gcloud alpha compute tpus queued-resources list
|
||||
|
||||
EXAMPLES
|
||||
To delete a Queued Resource in zone us-central1-b and project my-project,
|
||||
run:
|
||||
|
||||
$ gcloud alpha compute tpus queued-resources delete \
|
||||
--zone=us-central1-b --project=my-project
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Queued resource resource - The Queued Resource you want 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 queued_resource 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.
|
||||
|
||||
QUEUED_RESOURCE
|
||||
ID of the queued_resource or fully qualified identifier for the
|
||||
queued_resource. To set the queued_resource attribute:
|
||||
▸ provide the argument queued_resource on the command line.
|
||||
|
||||
This positional must be specified if any of the other arguments in
|
||||
this group are specified.
|
||||
|
||||
--zone=ZONE
|
||||
The compute/zone of the Cloud TPU.
|
||||
|
||||
If not specified, will use default compute/zone.
|
||||
|
||||
To set the zone attribute:
|
||||
▸ provide the argument queued_resource on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --zone on the command line;
|
||||
▸ set the property compute/zone.
|
||||
|
||||
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 tpu/v2alpha1 API. The full documentation for this API
|
||||
can be found at: https://cloud.google.com/tpu/
|
||||
|
||||
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.
|
||||
|
||||
71
gcloud/alpha/compute/tpus/queued-resources/describe
Normal file
71
gcloud/alpha/compute/tpus/queued-resources/describe
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
NAME
|
||||
gcloud alpha compute tpus queued-resources describe - describe a Queued
|
||||
Resource
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha compute tpus queued-resources describe
|
||||
(QUEUED_RESOURCE : --zone=ZONE) [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Get details on a Queued Resource.
|
||||
|
||||
To get a list of Queued Resources to describe in more detail, run:
|
||||
|
||||
$ gcloud alpha compute tpus queued-resources list
|
||||
|
||||
EXAMPLES
|
||||
To describe a Queued Resource with ID my-queued-resource in zone
|
||||
us-central1-b and project 'my-project', run:
|
||||
|
||||
$ gcloud alpha compute tpus queued-resources describe \
|
||||
my-queued-resource --zone=us-central1-b --project=my-project
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Queued resource resource - The Queued Resource you want 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 queued_resource 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.
|
||||
|
||||
QUEUED_RESOURCE
|
||||
ID of the queued_resource or fully qualified identifier for the
|
||||
queued_resource. To set the queued_resource attribute:
|
||||
▸ provide the argument queued_resource on the command line.
|
||||
|
||||
This positional must be specified if any of the other arguments in
|
||||
this group are specified.
|
||||
|
||||
--zone=ZONE
|
||||
The compute/zone of the Cloud TPU.
|
||||
|
||||
If not specified, will use default compute/zone.
|
||||
|
||||
To set the zone attribute:
|
||||
▸ provide the argument queued_resource on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --zone on the command line;
|
||||
▸ set the property compute/zone.
|
||||
|
||||
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 tpu/v2alpha1 API. The full documentation for this API
|
||||
can be found at: https://cloud.google.com/tpu/
|
||||
|
||||
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.
|
||||
|
||||
36
gcloud/alpha/compute/tpus/queued-resources/help
Normal file
36
gcloud/alpha/compute/tpus/queued-resources/help
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
NAME
|
||||
gcloud alpha compute tpus queued-resources - list, create, delete, and
|
||||
manage Queued Resources
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha compute tpus queued-resources COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) List, create, delete, and manage Queued Resources.
|
||||
|
||||
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 Queued Resource.
|
||||
|
||||
delete
|
||||
(ALPHA) Delete a Queued Resource.
|
||||
|
||||
describe
|
||||
(ALPHA) Describe a Queued Resource.
|
||||
|
||||
list
|
||||
(ALPHA) List Queued Resources.
|
||||
|
||||
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.
|
||||
|
||||
89
gcloud/alpha/compute/tpus/queued-resources/list
Normal file
89
gcloud/alpha/compute/tpus/queued-resources/list
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
NAME
|
||||
gcloud alpha compute tpus queued-resources list - list Queued Resources
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha compute tpus queued-resources list [--zone=ZONE]
|
||||
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
|
||||
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) List all Queued Resources associated with a project and location.
|
||||
|
||||
EXAMPLES
|
||||
To list all Queued Resources available in zone us-central1-b for project
|
||||
my-project, run:
|
||||
|
||||
$ gcloud alpha compute tpus queued-resources list \
|
||||
--zone=us-central1-b --project=my-project
|
||||
|
||||
FLAGS
|
||||
Location resource - The compute/zone of the Queued Resource.
|
||||
|
||||
If not specified, will use the value of the [compute/zone] property in the
|
||||
current gcloud configuration. To find a list of compute zones available
|
||||
for Cloud TPUs in your project, run gcloud alpha compute tpus
|
||||
queued-resources locations list. 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 --zone on the command line with a fully
|
||||
specified name;
|
||||
◆ set the property compute/zone with a fully specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
--zone=ZONE
|
||||
ID of the location or fully qualified identifier for the location. To
|
||||
set the zone attribute:
|
||||
▸ provide the argument --zone on the command line;
|
||||
▸ set the property compute/zone.
|
||||
|
||||
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 tpu/v2alpha1 API. The full documentation for this API
|
||||
can be found at: https://cloud.google.com/tpu/
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -4,10 +4,11 @@ NAME
|
|||
SYNOPSIS
|
||||
gcloud alpha compute tpus tpu-vm scp [[USER@]INSTANCE:]SRC
|
||||
[[[USER@]INSTANCE:]SRC ...] [[USER@]INSTANCE:]DEST [--compress]
|
||||
[--dry-run] [--force-key-file-overwrite] [--internal-ip] [--plain]
|
||||
[--recurse] [--scp-flag=SCP_FLAG] [--ssh-key-file=SSH_KEY_FILE]
|
||||
[--dry-run] [--force-key-file-overwrite] [--plain] [--recurse]
|
||||
[--scp-flag=SCP_FLAG] [--ssh-key-file=SSH_KEY_FILE]
|
||||
[--strict-host-key-checking=STRICT_HOST_KEY_CHECKING]
|
||||
[--worker=WORKER; default="0"] [--zone=ZONE]
|
||||
[--internal-ip | --tunnel-through-iap]
|
||||
[--ssh-key-expiration=SSH_KEY_EXPIRATION
|
||||
| --ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
|
|
@ -38,12 +39,6 @@ FLAGS
|
|||
regenerated and will fail in both interactive and non-interactive
|
||||
environments.
|
||||
|
||||
--internal-ip
|
||||
Connect to TPU VMs using their internal IP addresses rather than their
|
||||
external IP addresses. Use this to connect from a Google Compute Engine
|
||||
VM to a TPU VM on the same VPC network, or between two peered VPC
|
||||
networks.
|
||||
|
||||
--plain
|
||||
Suppress the automatic addition of ssh(1)/scp(1) flags. This flag is
|
||||
useful if you want to take care of authentication yourself or use
|
||||
|
|
@ -98,6 +93,32 @@ FLAGS
|
|||
Alternatively, the zone can be stored in the environment variable
|
||||
CLOUDSDK_COMPUTE_ZONE.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--internal-ip
|
||||
Connect to TPU VMs using their internal IP addresses rather than
|
||||
their external IP addresses. Use this to connect from a Google
|
||||
Compute Engine VM to a TPU VM on the same VPC network, or between two
|
||||
peered VPC networks.
|
||||
|
||||
--tunnel-through-iap
|
||||
Tunnel the SSH connection through Cloud Identity-Aware Proxy for TCP
|
||||
forwarding.
|
||||
|
||||
This flag must be specified to attempt to connect via IAP tunneling.
|
||||
If it is not set, and connection to a Cloud TPU VM without external
|
||||
IP address is attempted from outside the network, then the command
|
||||
will fail.
|
||||
|
||||
To use IAP tunneling, there must be firewall access to the SSH port
|
||||
for the IAP TCP IP address range for the network the TPU is created
|
||||
in. See the user guide
|
||||
(https://cloud.google.com/iap/docs/using-tcp-forwarding) for more
|
||||
details.
|
||||
|
||||
To learn more, see the IAP for TCP forwarding documentation
|
||||
(https://cloud.google.com/iap/docs/tcp-forwarding-overview).
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--ssh-key-expiration=SSH_KEY_EXPIRATION
|
||||
|
|
|
|||
|
|
@ -3,11 +3,12 @@ NAME
|
|||
|
||||
SYNOPSIS
|
||||
gcloud alpha compute tpus tpu-vm ssh [USER@]TPU [--dry-run]
|
||||
[--force-key-file-overwrite] [--internal-ip] [--plain]
|
||||
[--ssh-flag=SSH_FLAG] [--ssh-key-file=SSH_KEY_FILE]
|
||||
[--force-key-file-overwrite] [--plain] [--ssh-flag=SSH_FLAG]
|
||||
[--ssh-key-file=SSH_KEY_FILE]
|
||||
[--strict-host-key-checking=STRICT_HOST_KEY_CHECKING]
|
||||
[--worker=WORKER; default="0"] [--zone=ZONE]
|
||||
[--command=COMMAND --output-directory=OUTPUT_DIRECTORY]
|
||||
[--internal-ip | --tunnel-through-iap]
|
||||
[--ssh-key-expiration=SSH_KEY_EXPIRATION
|
||||
| --ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER] [GCLOUD_WIDE_FLAG ...]
|
||||
[-- SSH_ARGS ...]
|
||||
|
|
@ -47,12 +48,6 @@ FLAGS
|
|||
regenerated and will fail in both interactive and non-interactive
|
||||
environments.
|
||||
|
||||
--internal-ip
|
||||
Connect to TPU VMs using their internal IP addresses rather than their
|
||||
external IP addresses. Use this to connect from a Google Compute Engine
|
||||
VM to a TPU VM on the same VPC network, or between two peered VPC
|
||||
networks.
|
||||
|
||||
--plain
|
||||
Suppress the automatic addition of ssh(1)/scp(1) flags. This flag is
|
||||
useful if you want to take care of authentication yourself or use
|
||||
|
|
@ -139,6 +134,32 @@ FLAGS
|
|||
The logs will be written in files named {WORKER_ID}.log. For example:
|
||||
"2.log".
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--internal-ip
|
||||
Connect to TPU VMs using their internal IP addresses rather than
|
||||
their external IP addresses. Use this to connect from a Google
|
||||
Compute Engine VM to a TPU VM on the same VPC network, or between two
|
||||
peered VPC networks.
|
||||
|
||||
--tunnel-through-iap
|
||||
Tunnel the SSH connection through Cloud Identity-Aware Proxy for TCP
|
||||
forwarding.
|
||||
|
||||
This flag must be specified to attempt to connect via IAP tunneling.
|
||||
If it is not set, and connection to a Cloud TPU VM without external
|
||||
IP address is attempted from outside the network, then the command
|
||||
will fail.
|
||||
|
||||
To use IAP tunneling, there must be firewall access to the SSH port
|
||||
for the IAP TCP IP address range for the network the TPU is created
|
||||
in. See the user guide
|
||||
(https://cloud.google.com/iap/docs/using-tcp-forwarding) for more
|
||||
details.
|
||||
|
||||
To learn more, see the IAP for TCP forwarding documentation
|
||||
(https://cloud.google.com/iap/docs/tcp-forwarding-overview).
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--ssh-key-expiration=SSH_KEY_EXPIRATION
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue