WorkstationCluster

Property	Value
Google Cloud Service Name	Cloud Workstations
Google Cloud Service Documentation	/workstations/docs/
Google Cloud REST Resource Name	v1.projects.locations.workstationClusters
Google Cloud REST Resource Documentation	/workstations/docs/reference/rest/v1/projects.locations.workstationClusters
Config Connector Resource Short Names	workstationcluster
Config Connector Service Name	workstations.googleapis.com
Config Connector Resource Fully Qualified Name	workstationclusters.workstations.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	No
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Spec

Schema

annotations:
- key: string
  value: string
displayName: string
labels:
- key: string
  value: string
location: string
networkRef:
  external: string
  name: string
  namespace: string
privateClusterConfig:
  allowedProjects:
  - external: string
    kind: string
    name: string
    namespace: string
  enablePrivateEndpoint: boolean
projectRef:
  external: string
  kind: string
  name: string
  namespace: string
resourceID: string
subnetworkRef:
  external: string
  name: string
  namespace: string

Fields

Fields
`annotations` Optional	`list (object)` Optional. Client-specified annotations.
`annotations[]` Optional	`object`
`annotations[].key` Optional	`string` Key for the annotation.
`annotations[].value` Optional	`string` Value for the annotation.
`displayName` Optional	`string` Optional. Human-readable name for this workstation cluster.
`labels` Optional	`list (object)` Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
`labels[]` Optional	`object`
`labels[].key` Optional	`string` Key for the label.
`labels[].value` Optional	`string` Value for the label.
`location` Optional	`string` The location of the cluster.
`networkRef` Required*	`object` Immutable. Reference to the Compute Engine network in which instances associated with this workstation cluster will be created.
`networkRef.external` Optional	`string` A reference to an externally managed Compute Network resource. Should be in the format `projects/{{projectID}}/global/networks/{{network}}`.
`networkRef.name` Optional	`string` The `name` field of a `ComputeNetwork` resource.
`networkRef.namespace` Optional	`string` The `namespace` field of a `ComputeNetwork` resource.
`privateClusterConfig` Optional	`object` Optional. Configuration for private workstation cluster.
`privateClusterConfig.allowedProjects` Optional	`list (object)` Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
`privateClusterConfig.allowedProjects[]` Optional	`object` The Project that this resource belongs to.
`privateClusterConfig.allowedProjects[].external` Optional	`string` The `projectID` field of a project, when not managed by Config Connector.
`privateClusterConfig.allowedProjects[].kind` Optional	`string` The kind of the Project resource; optional but must be `Project` if provided.
`privateClusterConfig.allowedProjects[].name` Optional	`string` The `name` field of a `Project` resource.
`privateClusterConfig.allowedProjects[].namespace` Optional	`string` The `namespace` field of a `Project` resource.
`privateClusterConfig.enablePrivateEndpoint` Optional	`boolean` Immutable. Whether Workstations endpoint is private.
`projectRef` Required*	`object` Immutable. The Project that this resource belongs to.
`projectRef.external` Optional	`string` The `projectID` field of a project, when not managed by Config Connector.
`projectRef.kind` Optional	`string` The kind of the Project resource; optional but must be `Project` if provided.
`projectRef.name` Optional	`string` The `name` field of a `Project` resource.
`projectRef.namespace` Optional	`string` The `namespace` field of a `Project` resource.
`resourceID` Optional	`string` Immutable. The WorkstationCluster name. If not given, the metadata.name will be used.
`subnetworkRef` Required*	`object` Immutable. Reference to the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
`subnetworkRef.external` Optional	`string` The ComputeSubnetwork selflink of form "projects/{{project}}/regions/{{region}}/subnetworks/{{name}}", when not managed by Config Connector.
`subnetworkRef.name` Optional	`string` The `name` field of a `ComputeSubnetwork` resource.
`subnetworkRef.namespace` Optional	`string` The `namespace` field of a `ComputeSubnetwork` resource.

annotations

Optional

list (object)

Optional. Client-specified annotations.

annotations[]

Optional

object

annotations[].key

Optional

string

Key for the annotation.

annotations[].value

Optional

string

Value for the annotation.

displayName

Optional

string

Optional. Human-readable name for this workstation cluster.

labels

Optional

list (object)

Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.

labels[]

Optional

object

labels[].key

Optional

string

Key for the label.

labels[].value

Optional

string

Value for the label.

location

Optional

string

The location of the cluster.

networkRef

Required*

object

Immutable. Reference to the Compute Engine network in which instances associated with this workstation cluster will be created.

networkRef.external

Optional

string

A reference to an externally managed Compute Network resource. Should be in the format `projects/{{projectID}}/global/networks/{{network}}`.

networkRef.name

Optional

string

The `name` field of a `ComputeNetwork` resource.

networkRef.namespace

Optional

string

The `namespace` field of a `ComputeNetwork` resource.

privateClusterConfig

Optional

object

Optional. Configuration for private workstation cluster.

privateClusterConfig.allowedProjects

Optional

list (object)

Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.

privateClusterConfig.allowedProjects[]

Optional

object

The Project that this resource belongs to.

privateClusterConfig.allowedProjects[].external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

privateClusterConfig.allowedProjects[].kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

privateClusterConfig.allowedProjects[].name

Optional

string

The `name` field of a `Project` resource.

privateClusterConfig.allowedProjects[].namespace

Optional

string

The `namespace` field of a `Project` resource.

privateClusterConfig.enablePrivateEndpoint

Optional

boolean

Immutable. Whether Workstations endpoint is private.

projectRef

Required*

object

Immutable. The Project that this resource belongs to.

projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

projectRef.name

Optional

string

The `name` field of a `Project` resource.

projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

resourceID

Optional

string

Immutable. The WorkstationCluster name. If not given, the metadata.name will be used.

subnetworkRef

Required*

object

Immutable. Reference to the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.

subnetworkRef.external

Optional

string

The ComputeSubnetwork selflink of form "projects/{{project}}/regions/{{region}}/subnetworks/{{name}}", when not managed by Config Connector.

subnetworkRef.name

Optional

string

The `name` field of a `ComputeSubnetwork` resource.

subnetworkRef.namespace

Optional

string

The `namespace` field of a `ComputeSubnetwork` resource.

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
externalRef: string
observedGeneration: integer
observedState:
  clusterHostname: string
  controlPlaneIP: string
  createTime: string
  degraded: boolean
  deleteTime: string
  etag: string
  gcpConditions:
  - code: integer
    message: string
  reconciling: boolean
  serviceAttachmentUri: string
  uid: string
  updateTime: string

Fields
`conditions`	`list (object)` Conditions represent the latest available observations of the object's current state.
`conditions[]`	`object`
`conditions[].lastTransitionTime`	`string` Last time the condition transitioned from one status to another.
`conditions[].message`	`string` Human-readable message indicating details about last transition.
`conditions[].reason`	`string` Unique, one-word, CamelCase reason for the condition's last transition.
`conditions[].status`	`string` Status is the status of the condition. Can be True, False, Unknown.
`conditions[].type`	`string` Type is the type of the condition.
`externalRef`	`string` A unique specifier for the WorkstationCluster resource in GCP.
`observedGeneration`	`integer` ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
`observedState`	`object` ObservedState is the state of the resource as most recently observed in GCP.
`observedState.clusterHostname`	`string` Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
`observedState.controlPlaneIP`	`string` Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
`observedState.createTime`	`string` Output only. Time when this workstation cluster was created.
`observedState.degraded`	`boolean` Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in [conditions][google.cloud.workstations.v1.WorkstationCluster.conditions].
`observedState.deleteTime`	`string` Output only. Time when this workstation cluster was soft-deleted.
`observedState.etag`	`string` 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.
`observedState.gcpConditions`	`list (object)` Output only. Status conditions describing the workstation cluster's current state.
`observedState.gcpConditions[]`	`object`
`observedState.gcpConditions[].code`	`integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
`observedState.gcpConditions[].message`	`string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
`observedState.reconciling`	`boolean` Output only. Indicates whether this workstation cluster is currently being updated to match its intended state.
`observedState.serviceAttachmentUri`	`string` Output only. Service attachment URI for the workstation cluster. The service attachment is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
`observedState.uid`	`string` Output only. A system-assigned unique identifier for this workstation cluster.
`observedState.updateTime`	`string` Output only. Time when this workstation cluster was most recently updated.

Sample YAML(s)

Basic WorkstationCluster

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: workstations.cnrm.cloud.google.com/v1beta1
kind: WorkstationCluster
metadata:
  name: workstationcluster-sample
spec:
  projectRef:
    external: "projects/${PROJECT_NUMBER1}"
  location: us-west1
  networkRef:
    name: computenetwork-dep
  subnetworkRef:
    name: computesubnetwork-dep
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
  name: computenetwork-dep
spec:
  routingMode: GLOBAL
  autoCreateSubnetworks: false
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeSubnetwork
metadata:
  name: computesubnetwork-dep
spec:
  ipCidrRange: 10.0.0.0/24
  region: us-west1
  networkRef:
    name: computenetwork-dep

WorkstationCluster With Privateclusterconfig

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: workstations.cnrm.cloud.google.com/v1beta1
kind: WorkstationCluster
metadata:
  name: workstationcluster-sample
spec:
  projectRef:
    external: "projects/${PROJECT_NUMBER1}"
  location: us-west1
  displayName: workstationcluster-sample-displayname
  annotations:
    - key: a-key1
      value: a-value1
  labels:
    - key: l-key1
      value: l-value1
  networkRef:
    name: computenetwork-dep
  subnetworkRef:
    name: computesubnetwork-dep
  privateClusterConfig:
    enablePrivateEndpoint: true
    allowedProjects:
    - external: "projects/${PROJECT_NUMBER1}"
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
  name: computenetwork-dep
spec:
  routingMode: GLOBAL
  autoCreateSubnetworks: false
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeSubnetwork
metadata:
  name: computesubnetwork-dep
spec:
  ipCidrRange: 10.0.0.0/24
  region: us-west1
  networkRef:
    name: computenetwork-dep