Learn how to set up and use workstation clusters, workstation configurations,and workstations. Check the prerequisites for this quickstartbefore you begin,and then follow these steps:

1. Create a workstation cluster
2. Create a workstation configuration
3. Create and launch a workstation

If you no longer need the resources created in this quickstart,make sure that youclean up to avoid incurring extra costs.

To follow step-by-step guidance for this task directly in the Google Cloud console, clickGuide me:

Guide me

Before you begin

This guide covers steps for administrators to set up Cloud Workstations and for developers to use the workstations.

To set up Cloud Workstations, complete the following steps:

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

If you're using an existing project for this guide,verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

If you're using an existing project for this guide,verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

1. Enable the Cloud Workstations API.

   Roles required to enable APIs

   To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

   Enable the API

Required roles

To get the permissions that you need to manage and use workstations, ask your administrator to grant you the following IAM roles:

• Create and manage workstation clusters and configurations:Cloud Workstations Admin (roles/workstations.admin) on the project
• Create workstations using a configuration:Cloud Workstations Creator (roles/workstations.workstationCreator) on the project or the workstation configuration
• Use a workstation:Cloud Workstations User (roles/workstations.user) on the workstation. This is automatically granted on workstations you create.

For more information about granting roles, seeManage access to projects, folders, and organizations.

You might also be able to get the required permissions throughcustom roles or otherpredefined roles.

For a detailed overview of all Cloud Workstations roles, seeAccess control with IAM.

Create a workstation cluster

Workstation clusters aren't related to Google Kubernetes Engine (GKE) clusters.To create a workstation cluster, follow these steps:

1. In the console,navigate to theCloud Workstations >Cluster management page.

   Go to Cluster management

2. From the workstationsCluster management page, clickadd_boxCreate.

3. In theName field, entertest-cluster as the name of yourworkstation cluster.

4. Select theRegion that is closest to you.

5. Skip theNetwork settings.

6. ClickCreate, which begins the cluster creation process.

Workstation cluster creation can take up to 20 minutes, but in mostcases is only needed once.

Create a workstation configuration

1. In the console,navigate toCloud Workstations >Workstation configurations.

   Go to Workstation configurations

2. From theWorkstation configurations page, clickadd_boxCreate.

   

3. In theName field, entertest-configuration as the name of yourworkstation configuration.

4. Choosetest-cluster from the list of available workstationClustersand clickContinue.If no workstation cluster is available, make sure that you completed the steps to=Create a workstation cluster.

5. ForQuick start workstations, selectDisabled for lower cost.

6. If you were customizing a workstation configuration for your team, you mightdefineMachine settings, customizeEnvironment settings, and addusers to theIAM policy. For this exercise, you can skip those steps.

7. To create your workstation configuration, clickCreate.

For more information about creating a workstation configuration with the optionsthat were skipped in this quickstart, see the detailed section aboutworkstation configurations.

Create and launch a workstation

1. In the Google Cloud console, navigate to theCloud Workstations >Workstationspage.

   Go to Workstations

2. Clickadd_boxCreate.

   TheCreate link might be disabled if there aren't anyworkstation configurations in the project or if you don't have permissionsto view them.Ask your organization's Cloud Workstations Admin to create aworkstation configuration for you.

3. Accept the default workstationName.

4. Click thearrow_drop_downexpanderarrow in theConfiguration field and select theworkstation configuration to define your workstation.For example, if you named your workstation configurationtest-configuration in the prior step, select that from the list.

5. ClickCreateto create your workstation.

1. ClickWorkstations.
2. Find the workstation that you created in the list of available workstations,select the checkbox beside it, and then clickStart. This starts yourworkstation, and matches it to the parent workstation configuration.
3. If prompted to start your workstation, clickStart to confirm.The status changes toStarting and the status iconrefreshspins while the startoperation is in progress. It might take a few minutes to start yourworkstation.
4. When your workstation is ready, the status changes toRunning and thestatus icon changes to acheck_circle checkmark.

5. ClickLaunch. The workstation connects to port80 by default.

6. The following example shows the welcome page for the Cloud Workstationsbase editor.Your page might look different, depending on how you define yourworkstation configuration:

   

   For more information about connecting through SSH, seeSSH support.

   For more information about connecting to web apps running on yourworkstation, seeAccess HTTP servers running on a workstation.

Clean up

To avoid incurring charges to your Google Cloud account for the resourcesused on this page, make sure that you delete resources that you no longer need.

To delete a Google Cloud project from the Google Cloud console or from thegcloud CLI:

What's next

• Use theCloud Workstations base editor.

• Learn more about configuring additional options in yourworkstation configuration.

• Use Cloud Workstations withJetBrains IDEs such as IntelliJ IDEA Ultimate and PyCharm Professional.