Register external data volumes

Follow the instructions in this topic to register an external data volume (EDV) with Domino.

In a hybrid deployment, if you have a shared volume that can be accessed from multiple data planes, you can manage access to it using a single EDV across multiple data planes. Domino matches EDVs to PersistentVolumeClaims (PVCs) using the name of both the PVC and the underlying persistent volume (PV). Multiple data planes are automatically detected when registering the EDV.

If you see a PVC showing up in a data plane that you do not intend to use with an EDV, rename that PVC or PV so as not to match the PVC name of your EDV.

To register an EDV

From the Admin application, go to Data > External Volumes.
Click Register External Volume. The Register an External Volume wizard opens.
On the Volume page:
1. Select the volume type. The supported volume types are NFS, Windows Share(SMB), EFS, and Generic.
2. From Available Volumes, select a volume. The volume names are those of the backing Kubernetes persistent volume claims (PVCs).
  
  When you select a volume in a hybrid deployment, Domino displays a list of data planes where that EDV can be used, such as "local" in the example below:
Click Next
On the Configuration step:
1. Enter a Name. This field defaults to the selected PVC name but can be changed. Domino recommends that you name the EDV so that it is recognized by users based on the supporting use case or some organization-defined convention.
2. Enter a unique Relative Mount Path for the EDV for supported executions. This field defaults to the selected PVC name but can be changed. This field must be unique to all registered EDVs. There are a few reserved words.
3. Select Mount as read-only set the EDV as read-only or clear the checkbox to make the EDV read-write. This is enforced at the Domino layer. More restrictive access controls at the Kubernetes or NFS layer overrule this setting. For example, if the PVC access mode is set to read-only, it does not matter if this field allows for read-write; the underlying permission of read-only will be enforced.
4. Enter a Description.
Click Next.
On the Access step:
1. Select the Volume Access:
  - Everyone. Allow EDV access to all logged-in users.
  - Specific users or organizations. Limit EDV access to specific users and organizations.
    
    Note
    
    Regardless of this setting, you (SysAdmin) can always access any external data volume.
Click Register.