Console

1. In the Google Cloud console, go to theInstances page.

   Go to Instances

2. Clickadd_box Create new.

3. In theNew instance dialog, clickAdvanced options.

4. In theCreate instance dialog,in theDetails section,provide the following information for your new instance:

   • Name: Provide a name for your new instance. The namemust start with a letter followed by up to 62 lowercase letters,numbers, or hyphens (-), and cannot end with a hyphen.
   • Region andZone: Select a region and zone forthe new instance. For best network performance,select the region that is geographically closest to you.See the availableVertex AI Workbenchlocations.
   • Labels: Optional. Provide custom key-value labels for theinstance.
   • Network tags: Optional. Providenetwork tagsfor the instance.

5. In theEnvironment section, provide the following:

   • JupyterLab version: Select a JupyterLab version.
   • Version: Use the latest version or a previous versionof Vertex AI Workbench instances.
   • Post-startup script: Optional. ClickBrowse toselect a script to run one time, after the instance is created.The path must be a URL or Cloud Storage path,for example:gs://PATH_TO_FILE/FILE_NAME.
   • Metadata: Optional. Provide custom metadata keys for theinstance.

6. In theMachine type section, provide the following:

   • Machine type: Select the number of CPUs and amount of RAM for yournew instance. Vertex AI Workbench provides monthly costestimates for each machine type that you select.

   • GPU: Optional. If you want GPUs, select theGPU typeandNumber of GPUs for your new instance. The accelerator typethat you want must be available in your instance'szone. To learn about accelerator availability by zone, seeGPU regions and zonesavailability.For information about the different GPUs, seeGPUs on Compute Engine.

     SelectInstall NVIDIA GPU driver automatically for me.

     Note: You can modify the machine type and GPU configuration foryour instance after it is created.For more information, seeChange machine type and configure GPUs ofa Vertex AI Workbench instance.

   • Shielded VM: Optional. Select or clear the following checkboxes:

     • Secure Boot
     • Virtual Trusted Platform Module (vTPM)
     • Integrity monitoring

   • Idle shutdown: Optional.

     • To change the number of minutes before shutdown,in theTime of inactivity before shutdown (Minutes) field,change the value to an integer from 10 through 1440.

     • To turn off idle shutdown, clearEnable Idle Shutdown.

7. In theDisks section, provide the following:

   • Disks: Optional. To change the default data disk settings,select aData disk type andData disk size in GB.For more information about disk types, seeStorage options.

   • Delete to trash: Optional. Select this checkbox to usethe operating system's default trash behavior, If you usethe default trash behavior, files deleted by using the JupyterLabuser interface are recoverable but these deleted filesdo use disk space.

   • Encryption: SelectGoogle-managed encryption key orCustomer-managed encryption key (CMEK).To use CMEK, seeCustomer-managed encryption keys.

8. In theNetworking section, provide the following:

   • Networking: Adjust the network options to use a network inyour current project or aShared VPC network froma host project, if one is configured. If you are using aShared VPCin the host project, you must also grant theCompute Network User role(roles/compute.networkUser) to theNotebooks ServiceAgentfrom the service project.

     1. In theNetwork field, select the network that you want. Youcan select a VPC network, as long as the networkhasPrivate Google Accessenabled or can access the internet. For more information,seenetwork configuration options.

     2. In theSubnetwork field, select the subnetwork that you want.

     3. To turn off the external IP address,clear theAssign external IP address checkbox.

        Note: If you disableAssign external IP address, make sureto add DNS entries from theNetwork configuration optionssection.

     4. To turn off proxy access, clear theAllow proxy access checkbox.

        Note: If you turn off proxy access, you mustuse SSH to connectto your instance's JupyterLab interface.

9. In theIAM and security section, provide the following:

   • IAM and security: To grant access to the instance'sJupyterLab interface, complete one of the following steps:

     • To grant access to JupyterLab through a service account,selectService account.

       Caution: After you create the instance, you can't change the specified service account, either directly or by modifying the underlying Compute Engine VM. To use a different service account, you must create a new instance specifying the service account that you want.

       • To use the default Compute Engine service account,selectUse default Compute Engine service account.

       • To use a custom service account, clearUsedefault Compute Engine service account, and then,in theService account email field, enteryour custom service account email address.

     • To grant a single user access to the JupyterLab interface,do the following:

       1. SelectSingle user, and then,in theUser email field,enter the user account that you want to grant access. If thespecified user is not the creator of the instance, you must grantthe specified user theService Account Userrole(roles/iam.serviceAccountUser) on theinstance's service account.

       2. Your instance uses a service account to interact withGoogle Cloud services and APIs.

          • To use thedefault Compute Engine service account,selectUse default Compute Engine service account.

          • To use a custom service account, clearUsedefault Compute Engine service account, and then,in theService account email field, enteryour custom service account email address.

     Note: To grant access to the instance through the service account or single user option, you must use an individual's user account email address. Group access is not supported.

     To learn more about granting access,seeManage access.

   • Security options: Select or clear the following checkboxes:

     • Root access to the instance
     • nbconvert
     • File downloading
     • Terminal access

10. In theSystem health section, provide the following:

    • Environment upgrade and system health:To automatically upgrade to newly released environment versions,selectEnvironment auto-upgrade and complete theUpgrade schedule.

    • InReporting, select or clear the following checkboxes:

      • Report system health
      • Report custom metrics to Cloud Monitoring
      • Install Cloud Monitoring
      • Report DNS status for required Google domains

11. ClickCreate.

    Vertex AI Workbench creates an instance and automatically starts it.When the instance is ready to use, Vertex AI Workbenchactivates anOpen JupyterLab link.

gcloud

Before using any of the command data below, make the following replacements:

• INSTANCE_NAME: the name of your Vertex AI Workbench instance; must start with a letter followed by up to 62 lowercase letters, numbers, or hyphens (-), and cannot end with a hyphen
• PROJECT_ID: your project ID
• LOCATION: the zone where you want your instance to be located
• VM_IMAGE_PROJECT: the ID of the Google Cloud project that VM image belongs to; the default Google Cloud project ID for supported images iscloud-notebooks-managed
• VM_IMAGE_NAME: the image name; to find the image name of a specific version, seeFind the specific version
• MACHINE_TYPE: themachine type of your instance's VM

• METADATA: custom metadata to apply to this instance; for example, to specify a post-startup-script, you can use thepost-startup-script metadata tag, in the format:--metadata=post-startup-script=gs://BUCKET_NAME/hello.sh

  To enable the JupyterLab 4 preview, use--metadata=enable-jupyterlab4-preview=true. For more information, seeJupyterLab 4 preview.

Execute the following command:

gcloudworkbenchinstancescreateINSTANCE_NAME\--project=PROJECT_ID\--location=LOCATION\--vm-image-project=VM_IMAGE_PROJECT\--vm-image-name=VM_IMAGE_NAME\--machine-type=MACHINE_TYPE\--metadata=METADATA

gcloudworkbenchinstancescreateINSTANCE_NAME`--project=PROJECT_ID`--location=LOCATION`--vm-image-project=VM_IMAGE_PROJECT`--vm-image-name=VM_IMAGE_NAME`--machine-type=MACHINE_TYPE`--metadata=METADATA

gcloudworkbenchinstancescreateINSTANCE_NAME^--project=PROJECT_ID^--location=LOCATION^--vm-image-project=VM_IMAGE_PROJECT^--vm-image-name=VM_IMAGE_NAME^--machine-type=MACHINE_TYPE^--metadata=METADATA

For more information about the command for creating aninstance from the command line, see thegcloud CLIdocumentation.

Vertex AI Workbench creates an instance and automatically starts it.When the instance is ready to use, Vertex AI Workbenchactivates anOpen JupyterLab link in the Google Cloud console.

Terraform

The following sample uses thegoogle_workbench_instanceTerraform resource to createa Vertex AI Workbench instancenamedworkbench-instance-example.

To learn how to apply or remove a Terraform configuration, seeBasic Terraform commands.

resource "google_workbench_instance" "default" {  name     = "workbench-instance-example"  location = "us-central1-a"  gce_setup {    machine_type = "n1-standard-1"    accelerator_configs {      type       = "NVIDIA_TESLA_T4"      core_count = 1    }    vm_image {      project = "cloud-notebooks-managed"      family  = "workbench-instances"    }  }}

Console

To change the JupyterLab version on an existing instance,do the following:

1. In the Google Cloud console, go to theInstances page.

   Go to Instances

2. Shut down your instance.

3. Click the name of your instance to open theInstance details page.

4. On theSystem tab, do one of the following:

   • To enable JupyterLab 3, clear theEnable JupyterLab 4 checkbox.

   • To enable JupyterLab 4, leave theEnable JupyterLab 4 checkbox selected.

5. ClickSubmit.

6. To restart your instance, select the instance and clickarrow_right Start.

gcloud

You can change the JupyterLab version on an existing instance by usingthe following command:

gcloudworkbenchinstancesupdateINSTANCE_NAME\--project="PROJECT_ID"\--location="LOCATION"\--metadata=enable-jupyterlab4=ENABLEMENT_BOOLEAN

Replace the following:

• PROJECT_ID: your project ID
• LOCATION: the zone where you want your instance to be located
• INSTANCE_NAME: the name of your Vertex AI Workbench instance

• ENABLEMENT_BOOLEAN: use one of the following:

  • false: changes to JupyterLab 3.
  • true: changes to JupyterLab 4. JupyterLab 4 is enabled, by default.