gcloud alpha workstations configs create - create a workstation configuration
gcloud alpha workstations configs create (CONFIG : --cluster=CLUSTER --region=REGION) [--async] [--boot-disk-size=BOOT_DISK_SIZE; default=50] [--container-args=[CONTAINER_ARGS,...]] [--container-command=[CONTAINER_COMMAND,...]] [--container-env=[CONTAINER_ENV,...]] [--container-run-as-user=CONTAINER_RUN_AS_USER] [--container-working-dir=CONTAINER_WORKING_DIR] [--disable-public-ip-addresses] [--enable-confidential-compute] [--idle-timeout=IDLE_TIMEOUT; default=7200] [--machine-type=MACHINE_TYPE; default="e2-standard-4"] [--network-tags=[NETWORK_TAGS,...]] [--pd-disk-size=PD_DISK_SIZE; default=200] [--pd-disk-type=PD_DISK_TYPE; default="pd-standard"] [--pd-reclaim-policy=PD_RECLAIM_POLICY; default="delete"] [--pool-size=POOL_SIZE] [--running-timeout=RUNNING_TIMEOUT; default=7200] [--service-account=SERVICE_ACCOUNT] [--shielded-integrity-monitoring] [--shielded-secure-boot] [--shielded-vtpm] [--container-custom-image=CONTAINER_CUSTOM_IMAGE | --container-predefined-image=CONTAINER_PREDEFINED_IMAGE; default="codeoss"] [GCLOUD_WIDE_FLAG ...]
(ALPHA) Create a workstation configuration.
To create a configuration with the 'e2-standard-8' machine type and a IntelliJ image, run:
$ gcloud alpha workstations configs create CONFIG \ --machine-type=e2-standard-8 \ --container-predefined-image=intellij
To create a configuration with a Shielded VM instance that enables Secure Boot, virtual trusted platform module (vTPM) and integrity monitoring, run:
$ gcloud alpha workstations configs create CONFIG \ --machine-type=e2-standard-4 --shielded-secure-boot \ --shielded-vtpm --shielded-integrity-monitoring
To create a configuration with a non-default persistent disk containing 10GB of PD SSD storage, run:.RS 2m $ gcloud alpha workstations configs create CONFIG \ --machine-type=e2-standard-4 --pd-disk-type=pd-ssd \ --pd-disk-size=10
- Config resource - The group of arguments defining a config 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 config 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.
- CONFIG
ID of the config or fully qualified identifier for the config. To set the config attribute:
provide the argument config on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
- --cluster=CLUSTER
The cluster for the config. To set the cluster attribute:
provide the argument config on the command line with a fully specified name;
provide the argument --cluster on the command line.
- --region=REGION
The location for the config. To set the region attribute:
provide the argument config on the command line with a fully specified name;
provide the argument --region on the command line.
- --async
Return immediately, without waiting for the operation in progress to complete.
- --boot-disk-size=BOOT_DISK_SIZE; default=50
Size of the boot disk in GB.
- --container-args=[CONTAINER_ARGS,...]
Arguments passed to the entrypoint.
Example:
$ gcloud alpha workstations configs create \ --container-args=arg_1,arg_2
- --container-command=[CONTAINER_COMMAND,...]
If set, overrides the default ENTRYPOINT specified by the image.
Example:
$ gcloud alpha workstations configs create \ --container-command=executable,parameter_1,parameter_2
- --container-env=[CONTAINER_ENV,...]
Environment variables passed to the container.
Example:
$ gcloud alpha workstations configs create \ --container-env=key1=value1,key2=value2
- --container-run-as-user=CONTAINER_RUN_AS_USER
If set, overrides the USER specified in the image with the given uid.
- --container-working-dir=CONTAINER_WORKING_DIR
If set, overrides the default DIR specified by the image.
- --disable-public-ip-addresses
Default value is false. If set, instances will have no public IP address.
- --enable-confidential-compute
Default value is false. If set, instances will have confidential compute enabled.
- --idle-timeout=IDLE_TIMEOUT; default=7200
How long (in seconds) to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness.
- --machine-type=MACHINE_TYPE; default="e2-standard-4"
Machine type determines the specifications of the Compute Engine machines that the workstations created under this configuration will run on. MACHINE_TYPE must be one of: e2-standard-2, e2-standard-4, e2-standard-8, e2-standard-16, e2-standard-32, n2-standard-8, n1-standard-4, t2d-standard-6, n2d-standard-2, n2d-standard-4, n2d-standard-8, n2d-standard-16, n2d-standard-32.
- --network-tags=[NETWORK_TAGS,...]
Network tags to add to the Google Compute Engine machines backing the Workstations.
Example:
$ gcloud alpha workstations configs create --network-tags=tag_1,tag_2
- --pd-disk-size=PD_DISK_SIZE; default=200
Size of the persistent directory in GB. PD_DISK_SIZE must be one of: 10, 50, 100, 200, 500, 1000.
- --pd-disk-type=PD_DISK_TYPE; default="pd-standard"
Type of the persistent directory. PD_DISK_TYPE must be one of: pd-standard, pd-balanced, pd-ssd.
- --pd-reclaim-policy=PD_RECLAIM_POLICY; default="delete"
What should happen to the disk after the Workstation is deleted. PD_RECLAIM_POLICY must be one of:
- delete
The persistent disk will be deleted with the Workstation.
- retain
The persistent disk will be remain after the workstation is deleted and the administrator must manually delete the disk.
- --pool-size=POOL_SIZE
Number of instances to pool for faster Workstation starup.
- --running-timeout=RUNNING_TIMEOUT; default=7200
How long (in seconds) to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this config should never time out.
- --service-account=SERVICE_ACCOUNT
Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible.
- --shielded-integrity-monitoring
Default value is false. If set, instances will have integrity monitoring enabled.
- --shielded-secure-boot
Default value is false. If set, instances will have Secure Boot enabled.
- --shielded-vtpm
Default value is false. If set, instances will have vTPM enabled.
- At most one of these can be specified:
- --container-custom-image=CONTAINER_CUSTOM_IMAGE
A docker image for the workstation. This image must be accessible by the service account configured in this configuration (--service-account). If no service account is defined, this image must be public.
- --container-predefined-image=CONTAINER_PREDEFINED_IMAGE; default="codeoss"
Code editor on base images. CONTAINER_PREDEFINED_IMAGE must be one of:
- base-image
Base image - no IDE
- clion
CLion
- codeoss
Code OSS
- goland
GoLand
- intellij
IntelliJ IDEA Ultimate
- phpstorm
PhpStorm
- pycharm
PyCharm Professional
- rider
Rider
- rubymine
RubyMine
- webstorm
WebStorm
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.
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. This variant is also available:
$ gcloud beta workstations configs create