gcloud: Wed Apr 20 08:58:18 UTC 2022

gcloud/compute/tpus/tpu-vm/create

@@ -0,0 +1,191 @@
+NAME
+    gcloud compute tpus tpu-vm create - create a new Cloud TPU VM node
+
+SYNOPSIS
+    gcloud compute tpus tpu-vm create (TPU : --zone=ZONE) --version=VERSION
+        [--accelerator-type=ACCELERATOR_TYPE; default="v2-8"] [--async]
+        [--data-disk=DATA_DISK] [--description=DESCRIPTION] [--internal-ips]
+        [--labels=[LABELS,...]] [--metadata=[METADATA,...]]
+        [--metadata-from-file=[METADATA_FROM_FILE,...]]
+        [--network=NETWORK; default="default"] [--preemptible] [--range=RANGE]
+        [--reserved] [--scopes=[SCOPES,...]]
+        [--service-account=SERVICE_ACCOUNT] [--subnetwork=SUBNETWORK]
+        [--tags=[TAGS,...]] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Create a new Cloud TPU VM node.
+
+EXAMPLES
+    To create a TPU VM node with ID my-tpu in the default user project, network
+    and compute/zone (with other defaults supplied by API), run:
+
+        $ gcloud compute tpus tpu-vm create my-tpu
+
+    To create a TPU VM node in a specific network, run:
+
+        $ gcloud compute tpus tpu-vm create my-tpu --zone=us-central1-a \
+            --network=my-tf-network --description='My TPU VM' \
+            --version='v2-alpha'
+
+    To create a small TPU VM v2 pod, run:
+
+        $ gcloud compute tpus tpu-vm create my-tpu --zone=us-central1-a \
+            --accelerator-type='v2-32' --description='My TPU VM' \
+            --version='v2-alpha'
+
+POSITIONAL ARGUMENTS
+     Tpu resource - Name of the Cloud TPU VM node 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 tpu 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.
+
+       TPU
+          ID of the tpu or fully qualified identifier for the tpu. To set the
+          tpu attribute:
+          ▸ provide the argument tpu on the command line.
+
+          This positional must be specified if any of the other arguments in
+          this group are specified.
+
+       --zone=ZONE
+          Zone of the Cloud TPU.
+
+          If not specified, will use default compute/zone.
+
+          To set the zone attribute:
+          ▸ provide the argument tpu on the command line with a fully
+            specified name;
+          ▸ provide the argument --zone on the command line;
+          ▸ set the property compute/zone.
+
+REQUIRED FLAGS
+     --version=VERSION
+        Runtime version for the TPU, such as 2.3.
+
+        For a list of available versions run:
+
+        gcloud compute tpus tpu-vm versions list
+
+OPTIONAL FLAGS
+     --accelerator-type=ACCELERATOR_TYPE; default="v2-8"
+        TPU accelerator type for the TPU. If not specified, this defaults to
+        v2-8.
+
+        For a list of available accelerator types run:
+
+        gcloud compute tpus tpu-vm accelerator-types list
+
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --data-disk=DATA_DISK
+        Additional data disks for the TPU VM.
+
+        This flag must be repeated to provide multiple data disks. For example:
+
+            $ gcloud compute tpus tpu-vm create \
+                --data-disk \
+                source=projects/my-project/zones/us-central1-c/disks/my-disk,\
+            mode=read-only
+
+        The following keys are allowed:
+
+         source
+            Specifies the full path to an existing disk. Required. The disk
+            must be in the same zone.
+
+         mode
+            Specifies the mode in which to attach this disk. Valid options are
+            'read-write', 'read-only'. If not specified, the default is
+            'read-write'.
+
+     --description=DESCRIPTION
+        Text description of the TPU.
+
+     --internal-ips
+        Indicates that the IP addresses for the node should be internal. The
+        default is that external IP addresses will be associated with the TPU
+        workers.
+
+     --labels=[LABELS,...]
+        Resource labels to represent user-provided metadata. See
+        https://cloud.google.com/compute/docs/labeling-resources for details.
+
+     --metadata=[METADATA,...]
+        List of comma-separated metadata key-value pairs for the Cloud TPU VM
+        node.
+
+     --metadata-from-file=[METADATA_FROM_FILE,...]
+        Same as --metadata except the value for the entry will be read from a
+        local file.
+
+     --network=NETWORK; default="default"
+        Network that this TPU will be a part of.
+
+     --preemptible
+        If provided, the TPU will be preemptible and time-limited. It may be
+        preempted to free up resources for standard TPUs, and will only be able
+        to run for a limited amount of time.
+
+        Preemptible TPUs cannot be restarted.
+
+     --range=RANGE
+        CIDR Range for the TPU.
+
+        The IP range that the TPU will select an IP address from. Must be in
+        CIDR notation and a /29 range, for example 192.168.0.0/29. Errors will
+        occur if the CIDR range has already been used for a currently existing
+        TPU, the CIDR range conflicts with any networks in the user's provided
+        network, or the provided network is peered with another network that is
+        using that CIDR range.
+
+     --reserved
+        When specified, will attempt to create the TPU node under reservations
+        made in the current project. The reservations can be made separately
+        but used in aggregated form. i.e., the user can make a reservation of
+        128 V2 TPUs and later on make another reservation of 128 V2 TPUs then
+        creates a v2-256 TPU instance. If there exists no reservation or not
+        sufficient amount of reserved cores under the project, the request will
+        fail due to lack of capacity.
+
+     --scopes=[SCOPES,...]
+        List of comma-separated scopes to be made available for the service
+        account.
+
+     --service-account=SERVICE_ACCOUNT
+        Email address of the service account. If empty, default Google Compute
+        Engine service account will be used.
+
+     --subnetwork=SUBNETWORK
+        Subnetwork that this TPU will be a part of.
+
+     --tags=[TAGS,...]
+        Tags to apply to the TPU Node. Tags are used to identify valid sources
+        or targets for network firewalls. See
+        https://cloud.google.com/vpc/docs/add-remove-network-tags for more
+        details.
+
+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/v2 API. The full documentation for this API can
+    be found at: https://cloud.google.com/tpu/
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha compute tpus tpu-vm create
+