To create a workspace, you need to select few options including workspace name, cluster, resource, image and few advanced settings.

Workspace name

Once you start to create a new workspace, the default workspace name will be randomly generated. Specify a good name to remember.

Cluster

You can choose between VESSL Cloud, which is a cluster managed by VESSL AI, or a custom cluster that you register yourself. (See configure organization cluster for more details.) VESSL Cloud is always hosted on a cloud vendor’s server, while the custom cluster can be hosted either on a cloud server or on an on-premise server.

We support the following integrations:

  • AWS EKS
  • GCP GKE

Resource

Choose the type of resource that the container will use. Select the resource among the dropdown option or specify the requirements manually.

Max runtime

Specify the max runtime for this workspace. After max runtime, workspace will be automatically stopped.

For the Enterprise plan, Organization admin can limit the max runtime that users can input.

Image

You can choose the Docker image that the workspace container will use. There are two types of images: the Managed Image and the Custom Image. Select the Docker image type that you want to run on the workspace container.

For the Managed Image, you can simply select such an option, then the image managed by VESSL will be used in default. You can run Jupyter services on the managed image.

Debian based images are compatible.

Advanced Setting

Disk

You can specify the disk size to use in your container. This will be the request storage size of your PVC. The disk size cannot be changed once the workspace is created.

Disk size can be ignored in a custom cluster due to limitation of kubernetes. (official docs)

Port

You can customize port settings. By default, 8888 (jupyter) and 22 (ssh) are exposed.

Initialization (Init) script

Init script is a shell script that runs every time the workspace starts. Because /root is the only persistent directory, packages you installed outside the home directory may reset on stop and start. In this case, you can fill init script with install commands such as apt-get update && apt-get install ripgrep -y.