Workspaces

Overview

A Domino workspace is an interactive session where you can conduct research, analyze data, train models, and more. Workspaces enable you to work in a development environment of your choice, like Jupyter notebooks, RStudio , VS Code, and many other customizable environments.




Launch a workspace

  1. Click Workspaces in the Domino sidebar menu.

workspaces-1

  1. Click the + Create New Workspace button. A workspace launch modal will appear.

workspaces-2

  1. Enter a name for your workspace.
  2. Select an environment for your workspace. An environment is the software configuration (language, packages, etc.) that will be used in your workspace. You can select one of Domino’s pre-defined environments, or create a custom environment of your own. To learn more about managing environments, refer to the Domino environments documentation.
  3. Select the integrated development environment, or IDE, that you’ll use in your workspace (i.e., Jupyter, etc.). The IDEs available in this step are determined by the environment you select. The list of IDEs will update dynamically if a different environment is selected. To learn more about managing IDEs, refer to the Domino pluggable notebooks documentation.
  4. Select a hardware tier. A hardware tier represents the compute hardware used for your run. It can be a virtual instance in a cloud services provider, or a physical machine running in your deployment’s on-premise data center. To learn more about hardware tiers, refer to the hardware tier documentation.

workspaces-3

  1. Optionally, configure datasets or external data volumes in the “Data” section of the modal.

workspaces-4

  1. If necessary, attach a Spark compute cluster to your workspace. To learn more about Spark clusters, please refer to the Domino Spark documentation.

workspaces-5

  1. Click the Launch button. A loading screen will open in a new tab. You’ll be directed to your workspace when it’s ready. If you’re unable to access your workspace, check your browser’s configuration settings. Your browser should be configured to allow pop-up windows from Domino.

workspaces-6

workspaces-7

Attention

If you’re unable to access a newly launched workspace, check your browser’s configuration settings. Your browser should be configured to allow pop-up windows from Domino.

Attention

Domino imposes a limit of 2 workspaces per user per project, by default. To change this setting, please contact your Domino administrator.




Save your work

Use the various “Save” options in your IDE to save work you complete in your workspace.

Note that saving your work in a workspace is not the same thing as syncing your work to Domino. When you save changes in your workspace (using any of the various “Save” option(s) in your IDE) you’re simply saving your work within your workspace. If you’d like to push those changes to the Domino File System (DFS), you’ll have to sync your work to Domino instead.

workspaces-26




Sync your work to Domino

Attention

If you’re using a Git-based project with CodeSync, then the sidebar menu in your workspace look a little different. To learn more about saving and syncing your work using Git in a Git-based project with CodeSync, please see Working with Git.

Sync your work to the Domino File System (DFS) using the sidebar menu in your Domino workspace. You have the option of syncing all changes at once, or syncing only recent changes made to your files. We recommend that you sync your work at least daily.

Sync Changes to Files

  1. Click File Changes in the sidebar of your workspace.
  2. Under “Files”, view changes by expanding “File Changes”.
  3. Enter a commit message.
  4. Click Sync to Domino. Changes to files in the /mnt directory of your workspace will be synced to the Domino File System (DFS). Changes to files outside of the /mnt directory will not be synced.

workspaces-12

  1. After syncing to Domino is complete, you’ll be able to view your files in the Files section of Domino.

workspaces-12-1

Sync All Changes

  1. Click File Changes in the sidebar of your workspace.
  2. Under “All Changes”, enter a commit message.
  3. Click Sync All Changes. Domino will save all of your work / changes to the Domino File System (DFS).

workspaces-11

Warning

When saving your work, remember that changes to files outside of the /mnt directory will not persist if you stop your workspace and resume the workspace at a later time.




Stop a workspace

If necessary, you can stop a workspace and resume it at a later time. Frequently stopping and resuming a workspace session is a good way of managing compute costs (e.g., EC2). Storage costs (e.g., EBS), however, will continue to incur.

Attention

Stopping a workspace will not automatically sync your work to Domino. If you’d like to sync your work and files to Domino, you’ll need to sync from within a workspace.

To stop a workspace:

  1. Click Stop at the top of your workspace session. A modal with information about pausing your workspace will appear.

workspaces-13

  1. Click Stop My Workspace.

workspaces-14

workspaces-15

Persisted and reloaded settings

If you stop your workspace, the following settings will persist and will be available to you when you resume your workspace session at a later time:

  • Files saved in the /mnt directory

The following settings, however, will not persist and instead will reload when you resume your stopped workspace:

  • Files outside of the /mnt directory, including installed packages
  • Objects in memory
  • Datasets

If you’re using a Git-based project with CodeSync and the credentials to the git repository backing your code are updated or deleted while your workspace session is stopped, then the credentials will be updated correspondingly when you resume your workspace.




Resume a workspace

To resume a stopped workspace:

  1. Click Workspaces in the Domino sidebar menu.
  2. Navigate to the stopped workspace in your workspace dashboard. Click Start. Your workspace will resume in a new tab.

workspaces-16




View workspaces

View Your Workspaces

To view workspaces that you’ve launched:

  1. Click Workspaces in the Domino sidebar menu.
  2. Click My Workspaces in the toolbar above your workspaces.

workspaces-8

View All Workspaces in your Project

  1. Click Workspaces in the Domino sidebar menu.
  2. Click All Workspaces in the toolbar above your workspaces. Workspaces that you started, or that collaborators on your project started, are listed here.

workspaces-9

View Deleted Workspaces

  1. Click Workspaces in the Domino sidebar menu.
  2. Click Deleted in the toolbar above your workspaces.

workspaces-10

View Utility Workspaces

All non-durable workspaces (“legacy” workspaces) are listed in the Utility section. To view these workspaces:

  1. Click Workspaces in the Domino sidebar menu.
  2. Click Utility in the toolbar above your workspaces.

workspaces-12.1

workspaces-12.2




Delete a workspace

Warning

Ensure that all of your work is synced to Domino before deleting a workspace. Failure to do so will result in unrecoverable work.

You can delete a workspace if it’s no longer needed. Workspaces must be stopped before they can be deleted.

  1. If necessary, first stop your workspace. You can stop a workspace by clicking Stop in the workspaces dashboard, or clicking the Stop button in the toolbar from within your workspace dashboard.
  2. Navigate to the workspaces dashboard. Click the red trash bin icon.

workspaces-17

  1. In the modal that appears, confirm that you’d like to delete the workspace, then click Delete. The workspace will be deleted. You can view deleted workspaces by clicking Deleted at the top of your workspaces dashboard.

workspaces-18




Workspace settings and data

You can view your workspace’s settings, usage, logs, and history from the workspaces dashboard.

Workspace Settings

  1. Click Workspaces in the Domino sidebar menu.
  2. Click Settings in the corresponding workspace’s panel. You can view settings information about your code, environment, hardware tier, and datasets. You can also edit workspace settings by clicking the Edit Settings button. If you’d like to edit the workspace’s settings, stop the workspace.

workspaces-19

Workspace Usage

  1. Click Workspaces in the Domino sidebar menu.
  2. Click Usage in the corresponding workspace’s panel. The panel will expand to show CPU usage for your workspace.

workspaces-20

Workspace Logs

  1. Click Workspaces in the Domino sidebar menu.
  2. Click Logs in the corresponding workspace’s panel.

Here, you can view “User” logs and “Setup” logs about your workspace. User logs include information about actions you take within your workspace. Setup logs contain information about Domino and Kubernetes. If your workspace ever fails, the logs are a good place to begin investigating.

workspaces-21

workspaces-22

workspaces-23

Workspace History

  1. Click Workspaces in the Domino sidebar menu.
  2. Click History in the corresponding workspace’s panel. A modal will appear where you can view historical information about your workspace, like when a workspace was launched, stopped, and more.

workspaces-24

workspaces-25




Workspace volume size

Volumes represent the storage space dedicated to your workspace or Job. The default volume size for all workspaces and jobs in Domino is 10GiB. You can change the size of your volume if you find that your workspace (or Job) will require more storage space.

To change the size of your volume:

  1. Navigate to your project’s settings.
  2. Under “Workspace and Jobs Volume Size”, enter your desired volume size. The default minimum volume size is 4GiB, while the default maximum volume size is 200GiB. Both of these values are configurable. If you’d like to change the default minimum and maximum volume size limits, please contact your Domino administrator.

workspaces-28

Attention

Changes you make to the volume size will not impact existing workspaces. Instead, the changes will be applied to subsequent, new workspaces.