Configure External Storage (Connected Insights - Local)
Last updated
Last updated
The Storage Drives page allows you to configure the mounted external storage drive. It also displays the current disk space availability on the DRAGEN server v4 (in /staging) and external storage drives. Only Connected Insights - Local software users with an Administrator role have access. To view this page, login to Connected Insights - Local software, click your username in the top right of any page, select Administration Console, then Storage Drives.
Connected Insights - Local software uses DRAGEN server v4 local storage /staging to store resource files and databases required to process and display case results. The resource files are stored at following locations:
/staging/ici
/staging/ici_temp
Connected Insights - Local software uses an external storage drive directory to read the secondary analysis output data and to write analysis output data and backup files.
Configuring the external storage drive is an essential, one-time step setup during the initial installation process. Case ingestion will be blocked until external storage is configured. Below are the minimum requirements of the external storage which shall be mounted on the DRAGEN server v4:
Required: Configuration with CIFS/SMB or NFS protocols only.
Recommended: Use NFS v4.0 or CIFS/SMB v3.1 or higher versions for data security. Illumina also recommends an encrypted data storage drive to safeguard your data.
Required: 100 gigabytes (GB) of available storage space.
Recommended: 10 Gb (Gigabits) per second of network speed.
Required: External storage drive is always connected and accessible to the DRAGEN server v4 during the time of configuration setup.
Required: Previously mounted the external storage drive directory to the DRAGEN server v4 and knowledge of the UID and GID of a user with read and write access in that directory. For instructions on how to mount external storage and find the UID and GID.
Add External Storage configuration
❗ Instructions in this section can only be performed after mounting an external storage drive directory to the DRAGEN server v4. You must also know the UID and GID of a user with read and write access in that directory. For instructions on mounting and finding the UID and GID, see How To section section Get the UID:GID.
To enable external storage drive access to the Connected Insights - Local software, refer to below instructions:
From any page, click your username in the top right, select Administration Console, then Storage Drives. The Administration Console page is only accessible by Connected Insights - Local software users with an Administration role.
Click Add under the External storage section.
Provide the external storage mounted path, UID and GID of the user who has read write access to the external storage.
Click Save.
A confirmation pop up will be displayed indicating the application will be inaccessible while configuration is in progress.
Click OK on the confirmation pop up.
The application checks for below conditions and saves the settings only when the validations are successful:
The provided mounted path exists and is not a local directory.
The provided UID and GID are valid and that user has permission to the read and write in the mounted external storage drive.
The external storage drive directory has minimum of 100 GB free space.
While the configuration is in progress, Connected Insights - Local software will be inaccessible and takes approximately 20 to 25 minutes to complete the configuration. A maintenance page will be displayed to prevent user from performing any action on the application. The application will redirect to the login screen upon successful completion.
After the storage drive is successfully added, the application creates the following folders. In these folders, the application will write case output files with the UID and GID provided above:
/mnt/<External_storage_mounted_path>/d53e4b2d-0428-4b3e-92bf-955f7153c360
/mnt/<External_storage_mounted_path>/ici_<Server host name or IP address>
/mnt/<External_storage_mounted_path>/ici_report_temp
Upon sign in, if you see the notification below about missing software packages, click the hyperlink to the Software Update page in notification, and then install all the required packages by following the instructions in Software Update.
Notification: "One or more required packages are not installed. Go to Administration Console > Software Update to install."
Edit External Storage configuration
Connected Insights - Local software allows you to only change the UID and GID of mounted external storage drive. The mounted storage path cannot be changed or altered.
❗ It is not recommended to use this feature frequently as it impacts the existing data permissions generated by the application. This is because editing the current UID/GID will modify the permission of the existing data to the new UID/GID. Before performing this action, review the instructions on mounting with the new UID and GID under How To section Get the UID:GID.
To edit the existing storage drive UID and GID configuration, refer to below instructions:
From any page, click your username in the top right, select Administration Console, then Storage Drives. The Administration Console page is only accessible by Connected Insights - Local software users with an Administration role.
Click Edit under the existing External storage section.
Provide the UID and GID of the user with read write access to the external storage.
Click Save.
A confirmation pop up will be displayed indicating the application will be inaccessible while the configuration is in progress.
Click OK on the confirmation pop up.
While the configuration is in progress, Connected Insights - Local software will be inaccessible and a maintenance page will be displayed to prevent user from performing any action on the application (approximately 20 to 25 minutes).
The application checks for the condition below and saves the settings only when the validations are successful:
The provided UID and GID are valid and that user has permission to the read and write in the mounted external storage drive.
Storage Drive Notifications
Connected Insights - Local software displays the following error notifications and to prevent you from using one or more features when the following conditions are met:
When the configured storage drive is inaccessible, the following notification appears in the Cases, Overview, and Storage Drives pages. New case ingestion is blocked.
External storage drive is not accessible. Data Upload, variant details, reports and visualization feature will not be available
To ingest a new case, it is required to have a minimum of 50 GB free space on the external storage drive and 150 GB free space on the DRAGEN server v4 (in /staging). When the requirement is not met, this notification displays in the Cases page. Case ingestion is blocked.
Insufficient disk space on the DRAGEN server v4 and/or External storage drives. Case ingestion has been stopped. Please free up space to resume Case ingestion or contact Administrator.
When the configured external storage drive UID and/or GID permissions are altered from its configured settings, the following notification appears in the Cases, Overview, and Storage Drives pages.
External storage drive permissions have been changed from their configured settings. Data upload, variant details, reports and visualization features will not be available.
Disk space usage
The Storage Drives page allows you to monitor storage utilization. The page displays information on Connected Insights - Local software usage, other usage, and available space for both the DRAGEN server v4 (in /staging) and the external storage drive.