A Domino workspace is an interactive session where you can conduct research, analyze data, train models, and more. Use workspaces to work in the development environment of your choice, like Jupyter notebooks, RStudio, VS Code, and many other customizable environments.
-
In the navigation pane, click Workspaces.
-
Click + Create New Workspace. A workspace launch dialog opens.
-
Enter a name for your workspace.
-
Select an environment for your workspace. You can click one of Domino’s pre-defined environments, or create a custom environment of your own. To learn more about managing environments, see Customize the Domino Software Environment.
-
Select the integrated development environment, or IDE, that you’ll use in your workspace (such as Jupyter). The IDEs available in this step are determined by the environment you select. To learn more about managing IDEs, see Domino pluggable notebooks.
-
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.
-
Optional: Configure datasets or external data volumes in the Data section of the modal.
-
If necessary, attach a compute cluster to your workspace. To learn more about clusters, see the following:
-
Click Launch. A loading page opens in a new tab. You’ll be directed to your workspace when it’s ready.
You can edit your workspace’s settings to use a different hardware tier or a different environment.
-
Open the settings and click Edit Settings.
-
Make the changes and click Save & Restart.
Use Save in your IDE to save work you complete in your workspace.
Saving your work in a workspace is not the same as syncing your work to Domino. When you save changes in your workspace, 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.
Sync your work to the Domino File System (DFS) using the navigation menu in your Domino workspace. You can sync all changes at once, or sync only recent changes made to your files. Domino recommends that you sync your work at least daily.
-
Click File Changes in the navigation pane of your workspace.
-
Under Files, expand File Changes to view changes.
-
Enter a commit message.
-
Click Sync to Domino. Changes to files in the
/mntdirectory of your workspace will be synced to the Domino File System (DFS). Changes to files outside of the/mntdirectory will not be synced.
-
After syncing to Domino is complete, you can view your files in the Files section of Domino.
-
Click File Changes in the navigation bar of your workspace.
-
Under All Changes, enter a commit message.
-
Click Sync All Changes. Domino will save all your work to the Domino File System (DFS).
You can stop a workspace and resume it at a later time. Frequently stopping and resuming a workspace session is a good way to manage compute costs (for example, EC2). Storage costs (for example, EBS), however, will continue to incur.
-
Click Stop. A dialog with information about pausing your workspace opens.
-
Click Stop My Workspace.
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
/mntdirectory
The following settings, however, will not persist and instead will reload when you resume your stopped workspace:
-
Files outside of the
/mntdirectory, 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.
-
Click Workspaces in the navigation menu.
-
Go to the stopped workspace in your workspace dashboard. Click Start. Your workspace will resume in a new tab.
-
Click Workspaces in the navigation menu.
-
Click My Workspaces.
-
Click Workspaces in the navigation menu.
-
Click All Workspaces.
Workspaces that you started, or that collaborators on your project started, are listed here.
To view all workspaces in all your projects, go to the project list page. Your running and stopped workspace counts will show up on each project card.
+
-
Click Workspaces in the navigation menu.
-
Click Deleted in the toolbar above your workspaces.
-
Click Workspaces in the navigation menu.
-
Click Utility in the toolbar above your workspaces.
All non-durable workspaces ("legacy" workspaces) are listed in the Utility section.
+
+
|
Warning
|
Ensure that all 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.
-
Stop your workspace. You can stop a workspace by clicking Stop in the workspaces dashboard, or clicking Stop in the toolbar from within your workspace dashboard.
-
Go to the workspaces dashboard. Click the red trash bin icon.
-
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.
Settings are available for individual workspaces. You can also configure the automatic shutdown time for long-running workspaces.
Reconfigure a workspace
You can view a workspace’s settings from the workspaces dashboard.
-
Click Workspaces in the navigation menu.
-
Click Settings in the workspace’s panel.
You can view settings information about your code, environment, hardware tier, and datasets.
-
Click Edit Settings to change the workspace settings.
Here you can reconfigure any of the parameters you defined when you first created the workspace.
Configure long-running workspaces
Domino shuts down long-running workspaces after a period defined by your administrator. Follow these steps to adjust this period; you can make it shorter but not longer. This setting applies to all workspaces owned by you.
-
In the lower left, click your account name.
-
Click Account Settings:
-
Click Workspace Settings.
-
Select Shutdown my long-running workspaces after <n> minutes/hours.
If you leave this unselected, the time limit configured by your administrator applies.
-
Optionally, you can also select a different time limit for long-running workspaces.
Note
You can view your workspace’s usage, logs, and history from the workspaces dashboard.
Workspace logs
-
Click Workspaces in the navigation menu.
-
Click Logs in the workspace’s panel.
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 fails, the logs are a good place to begin investigating.
Volumes represent the storage space dedicated to your workspace or Job.
The default volume size for all workspaces and jobs in Domino is 10GiB, configurable by an administrator.
You can change the size of your volume if you find that your workspace (or Job) will require more storage space.
-
Go to your project’s settings.
-
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, contact your Domino administrator.
Workspaces started prior to an upgrade to Domino 4.5 do not have long-living persistent volumes backing them. You can find workspaces from before 4.5 on the My Workspaces or All Workspaces tab, and stopped workspaces under the Deleted tab.
The following is an example of what an old workspace looks like:
