External Data Volumes

Attention

To use external data volumes in your Domino project, a Domino administrator must first register and configure the volumes in your Domino deployment. Please reach out to your Domino administrator to learn more about registered external volumes and your corresponding access privileges.

If you’re a Domino administrator and would like to register or configure external volumes for a Domino deployment, please see: External Data Volumes (Administrator’s Guide).

Overview

Domino projects can access data stored in external data volumes. Domino supports the following data volumes: Network File Systems (generic NFS and AWS EFS) and Windows Share (SMB) .

When configured for use with your Domino deployment, external data volumes are automatically mounted to supported Domino executions. External volumes are supported in the following Domino executions:




Mount an external volume

  1. Click on Data in the Domino sidebar menu.

external-data-volumes-1

  1. Scroll to the “External Data Volumes” section.

external-data-volumes-2

  1. Click the Add External Volume button.

external-data-volumes-3

  1. In the modal that appears, select an available volume. Click into the text area to expand a dropdown menu of available volumes, or type into the text area to quickly search for a volume.

external-data-volumes-3-1

Attention

If you’re unable to view, search for, or select external volumes, they are either not registered in your deployment or you may not have the proper access privileges to the volumes. Please contact your Domino administrator for assistance.

  1. Click the Add button. If your volume is successfully mounted, it’ll be listed in a table in the “External Data Volumes” section of Data.

external-data-volumes-4




View mounted volumes

  1. Click on Data in the Domino sidebar menu.

external-data-volumes-1-2

  1. Scroll to the “External Data Volumes” section. If no volumes have been mounted, you’ll be prompted to mount a volume. If the project already has mounted volumes, they’ll appear here listed in a table along with the volume’s properties.

external-data-volumes-5

Attention

Unclickable or “greyed out” volumes listed in the table indicate that you do not have the privileges to use these volumes. If you need access to these volumes, please contact your Domino administrator. To learn more, please see the volume censorship levels below.

Volume Censorship Levels

Partial volume censorship

You may encounter mounted volumes that are “greyed out” in your volume table. This means that the volume(s) have been mounted to your project, but that you do not have access to them. To gain access to the volume(s), please contact your Domino administrator.

external-data-volumes-9

Full volume censorship

Your project may contain volumes that have been mounted to the project but are not listed (i.e., fully censored from view) in the volume table. A notification banner will appear above the table informing you about this. To gain access to the volumes, please contact your Domino administrator.

external-data-volumes-10




Properties of mounted volumes

Mounted volumes will appear in a table in the Data section of your project. The table will also display the following properties of the volume:

  • Name – An alias for the volume. To change this setting, contact your Domino administrator.
  • Type – The type of volume. Domino supports NFS, AWS EFS, and Windows Share (SMB).
  • Description – A description of the volume, set by your Domino administrator. To change the description, contact your Domino administrator.
  • Mount Path – The mount path of the volume: /domino/edv/name-of-volume. Use this mount path when using the volume in a Job, Workspace, or other supported Domino execution.

external-data-volumes-8




Use a mounted volume

By default, external volumes that are mounted to your project (and that you have access to) are also automatically mounted in supported executions. At the moment, supported Domino executions include Jobs (including Scheduled Jobs), Workspaces, Apps, Launchers, and on-demand Spark clusters. You can access a volume within an execution by referencing the mount path of the volume(s).

Mounted volumes in a Job

external-data-volumes-11

Mounted volumes in a Workspace

external-data-volumes-12

Mounted volumes in an App

external-data-volumes-13

Mounted volumes with a Launcher

Attention

Launcher users must have sufficient access privileges to any external volumes used by the Launcher. Otherwise, the volume(s) will not mount and the Launcher may not function properly. Please contact your Domino administrator for assistance with granting access privileges to users.

Mounted volumes with an on-demand Spark cluster

External data volumes are mounted at the full mount path on the driver and all Spark executors.

external-data-volumes-14




Unmount a volume

  1. Click on Data in the Domino sidebar menu.

external-data-volumes-6-1

  1. Click on the three vertical dots to the right of the corresponding entry in the table and then click on Remove in the menu that appears.

external-data-volumes-6

  1. Confirm (or cancel) removal in the subsequent modal that appears.

external-data-volumes-7



Current Limitations

  • Model APIs do not support external volumes.
  • External data volume actions are not exposed by the Domino REST API or Domino CLI.