- Resource: WorkstationConfig
- Host
- GceInstance
- GceShieldedInstanceConfig
- GceConfidentialInstanceConfig
- Accelerator
- BoostConfig
- PersistentDirectory
- GceRegionalPersistentDisk
- ReclaimPolicy
- EphemeralDirectory
- GcePersistentDisk
- Container
- CustomerEncryptionKey
- ReadinessCheck
- PortRange
- Methods
Resource: WorkstationConfig
A workstation configuration resource in the Cloud Workstations API.
Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use Identity and Access Management (IAM) rules to grant access to teams or to individual developers.
JSON representation |
---|
{ "name": string, "displayName": string, "uid": string, "reconciling": boolean, "annotations": { string: string, ... }, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "etag": string, "idleTimeout": string, "runningTimeout": string, "maxUsableWorkstations": integer, "host": { object ( |
Fields | |
---|---|
name |
Identifier. Full name of this workstation configuration. |
display |
Optional. Human-readable name for this workstation configuration. |
uid |
Output only. A system-assigned unique identifier for this workstation configuration. |
reconciling |
Output only. Indicates whether this workstation configuration is currently being updated to match its intended state. |
annotations |
Optional. Client-specified annotations. An object containing a list of |
labels |
Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. An object containing a list of |
create |
Output only. Time when this workstation configuration was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. Time when this workstation configuration was most recently updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
delete |
Output only. Time when this workstation configuration was soft-deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
etag |
Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. |
idle |
Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of A duration in seconds with up to nine fractional digits, ending with ' |
running |
Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The Provide duration terminated by Warning: A value of A duration in seconds with up to nine fractional digits, ending with ' |
max |
Optional. Maximum number of workstations under this configuration a user can have Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by:
If not specified, defaults to |
host |
Optional. Runtime host for the workstation. |
persistent |
Optional. Directories to persist across workstation sessions. |
ephemeral |
Optional. Ephemeral directories which won't persist across workstation sessions. |
container |
Optional. Container that runs upon startup for each workstation using this workstation configuration. |
encryption |
Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. |
readiness |
Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. |
replica |
Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, Immutable after the workstation configuration is created. |
degraded |
Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the |
conditions[] |
Output only. Status conditions describing the current resource state. |
enable |
Optional. Whether to enable Linux
|
disable |
Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. |
allowed |
Optional. A list of |
grant |
Optional. Grant creator of a workstation |
Host
Runtime host for a workstation.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field config . Type of host to be used for the workstation's runtime. config can be only one of the following: |
|
gce |
Specifies a Compute Engine instance as the host. |
GceInstance
A runtime using a Compute Engine instance.
JSON representation |
---|
{ "machineType": string, "serviceAccount": string, "serviceAccountScopes": [ string ], "tags": [ string ], "poolSize": integer, "pooledInstances": integer, "disablePublicIpAddresses": boolean, "enableNestedVirtualization": boolean, "shieldedInstanceConfig": { object ( |
Fields | |
---|---|
machine |
Optional. The type of machine to use for VM instances—for example, |
service |
Optional. The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has If you as the administrator want to be able to If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible. |
service |
Optional. Scopes to grant to the |
tags[] |
Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules. |
pool |
Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to |
pooled |
Output only. Number of instances currently available in the pool for faster workstation startup. |
disable |
Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use |
enable |
Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances:
|
shielded |
Optional. A set of Compute Engine Shielded instance options. |
confidential |
Optional. A set of Compute Engine Confidential VM instance options. |
boot |
Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is |
accelerators[] |
Optional. A list of the type and count of accelerator cards attached to the instance. |
boost |
Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. |
disable |
Optional. Whether to disable SSH access to the VM. |
vm |
Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format An object containing a list of |
GceShieldedInstanceConfig
A set of Compute Engine Shielded instance options.
JSON representation |
---|
{ "enableSecureBoot": boolean, "enableVtpm": boolean, "enableIntegrityMonitoring": boolean } |
Fields | |
---|---|
enable |
Optional. Whether the instance has Secure Boot enabled. |
enable |
Optional. Whether the instance has the vTPM enabled. |
enable |
Optional. Whether the instance has integrity monitoring enabled. |
GceConfidentialInstanceConfig
A set of Compute Engine Confidential VM instance options.
JSON representation |
---|
{ "enableConfidentialCompute": boolean } |
Fields | |
---|---|
enable |
Optional. Whether the instance has confidential compute enabled. |
Accelerator
An accelerator card attached to the instance.
JSON representation |
---|
{ "type": string, "count": integer } |
Fields | |
---|---|
type |
Optional. Type of accelerator resource to attach to the instance, for example, |
count |
Optional. Number of accelerator cards exposed to the instance. |
BoostConfig
A configuration that workstations can boost to.
JSON representation |
---|
{
"id": string,
"machineType": string,
"accelerators": [
{
object ( |
Fields | |
---|---|
id |
Optional. Required. The ID to be used for the boost configuration. |
machine |
Optional. The type of machine that boosted VM instances will use—for example, |
accelerators[] |
Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to |
boot |
Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is |
enable |
Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances:
|
pool |
Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to |
PersistentDirectory
A directory to persist across workstation sessions.
JSON representation |
---|
{ "mountPath": string, // Union field |
Fields | |
---|---|
mount |
Optional. Location of this directory in the running workstation. |
Union field directory_type . How a persistent directory should be implemented. directory_type can be only one of the following: |
|
gce |
A PersistentDirectory backed by a Compute Engine persistent disk. |
GceRegionalPersistentDisk
A Persistent Directory backed by a Compute Engine regional persistent disk. The persistentDirectories
field is repeated, but it may contain only one entry. It creates a persistent disk that mounts to the workstation VM at /home
when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.
JSON representation |
---|
{
"sizeGb": integer,
"fsType": string,
"diskType": string,
"sourceSnapshot": string,
"reclaimPolicy": enum ( |
Fields | |
---|---|
size |
Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if Valid values are |
fs |
Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if |
disk |
Optional. The type of the persistent disk for the home directory. Defaults to |
source |
Optional. Name of the snapshot to use as the source for the disk. If set, |
reclaim |
Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are |
ReclaimPolicy
Value representing what should happen to the disk after the workstation is deleted.
Enums | |
---|---|
RECLAIM_POLICY_UNSPECIFIED |
Do not use. |
DELETE |
Delete the persistent disk when deleting the workstation. |
RETAIN |
Keep the persistent disk when deleting the workstation. An administrator must manually delete the disk. |
EphemeralDirectory
An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.
JSON representation |
---|
{ "mountPath": string, // Union field |
Fields | |
---|---|
mount |
Required. Location of this directory in the running workstation. |
Union field directory_type . How an ephemeral directory should be implemented. directory_type can be only one of the following: |
|
gce |
An EphemeralDirectory backed by a Compute Engine persistent disk. |
GcePersistentDisk
An EphemeralDirectory is backed by a Compute Engine persistent disk.
JSON representation |
---|
{ "diskType": string, "sourceSnapshot": string, "sourceImage": string, "readOnly": boolean } |
Fields | |
---|---|
disk |
Optional. Type of the disk to use. Defaults to |
source |
Optional. Name of the snapshot to use as the source for the disk. Must be empty if |
source |
Optional. Name of the disk image to use as the source for the disk. Must be empty if |
read |
Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and |
Container
A Docker container.
JSON representation |
---|
{ "image": string, "command": [ string ], "args": [ string ], "env": { string: string, ... }, "workingDir": string, "runAsUser": integer } |
Fields | |
---|---|
image |
Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images, but you can create your own custom container images. If using a private image, the |
command[] |
Optional. If set, overrides the default ENTRYPOINT specified by the image. |
args[] |
Optional. Arguments passed to the entrypoint. |
env |
Optional. Environment variables passed to the container's entrypoint. An object containing a list of |
working |
Optional. If set, overrides the default DIR specified by the image. |
run |
Optional. If set, overrides the USER specified in the image with the given uid. |
CustomerEncryptionKey
A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow Cloud KMS best practices.
JSON representation |
---|
{ "kmsKey": string, "kmsKeyServiceAccount": string } |
Fields | |
---|---|
kms |
Immutable. The name of the Google Cloud KMS encryption key. For example, |
kms |
Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and |
ReadinessCheck
A readiness check to be performed on a workstation.
JSON representation |
---|
{ "path": string, "port": integer } |
Fields | |
---|---|
path |
Optional. Path to which the request should be sent. |
port |
Optional. Port to which the request should be sent. |
PortRange
A PortRange defines a range of ports. Both first
and last
are inclusive. To specify a single port, both first
and last
should be the same.
JSON representation |
---|
{ "first": integer, "last": integer } |
Fields | |
---|---|
first |
Required. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. |
last |
Required. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. |
Methods |
|
---|---|
|
Creates a new workstation configuration. |
|
Deletes the specified workstation configuration. |
|
Returns the requested workstation configuration. |
|
Gets the access control policy for a resource. |
|
Returns all workstation configurations in the specified cluster. |
|
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission. |
|
Updates an existing workstation configuration. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |