NAN Data Transport System: Difference between revisions
From Network for Advanced NMR
Jump to navigationJump to search
Mmaciejewski (talk | contribs) No edit summary |
Mmaciejewski (talk | contribs) |
||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:NAN Data Transport System (NDTS)}} | {{DISPLAYTITLE:NAN Data Transport System (NDTS) Overview}} | ||
{{NDTS_Navbox}} | {{NDTS_Navbox}} | ||
Line 12: | Line 12: | ||
! Component !! Location !! Role | ! Component !! Location !! Role | ||
|- | |- | ||
| '''Daemon''' || Spectrometer Workstation || Detects completed experiments, associates metadata, and sends data to the Gateway. | | '''Daemon''' || Spectrometer Workstation || | ||
Sends heartbeat information to the Gateway | * Detects completed experiments, associates metadata, and sends data to the Gateway. | ||
* Sends heartbeat information to the Gateway | |||
* Pulls user information from the Gateway | |||
|- | |- | ||
| ''' | |'''NDTS GUI''' | ||
|Spectrometer Workstation | |||
| | |||
* Shows data harvesting statuses | |||
* Allows the operator to change the NAN user and enter additional metadata | |||
|- | |- | ||
| ''' | | '''Gateway'''|| Within NMR facility network || | ||
* Receives data from all Daemons and relays it to the Receiver. Pulls user information from the NAN Receiver. | |||
* The Gateway should be a dedicated computer, but has minimal requirements with regard to CPU, memory, and storage. The exception to that is if the Gateway is setup to archive all datasets as a backup it needs the storage capacity to accommodate the data or even better mounted to an external storage device. | |||
|- | |- | ||
| ''' | | '''Receiver'''|| UCHC Data Center || | ||
* Accepts experiment data and metadata from Gateways | |||
* Packages user information destined for the spectrometer workstations | |||
|- | |- | ||
| ''' | | '''Parser'''|| UCHC Data Center || | ||
* Parses datasets to extract additional metadata, writes database entries, and stores dataset files to primary and disaster recovery storage appliances | |||
|- | |- | ||
| ''' | | '''PostgreSQL Database'''|| UCHC Data Center || | ||
* Stores datasets and their structured metadata | |||
|- | |- | ||
| ''' | | '''Primary Storage'''|| UCHC Data Center || | ||
* Stores copies of all collected experimental data | |||
|- | |- | ||
| '''Elasticsearch Database''' || UCHC Data Center || Indexes statistics about harvested datasets and heartbeat information for visualization from the virtual NAN Operation Center (vNOC) | | '''Disaster Recovery Storage'''|| Geo-dispersed || | ||
* Maintains redundant backups of all experimental data on a WORM S3 bucket | |||
|- | |||
| '''Elasticsearch Database''' || UCHC Data Center || | |||
* Indexes statistics about harvested datasets and heartbeat information for visualization from the virtual NAN Operation Center (vNOC) | |||
|} | |} | ||
Line 50: | Line 64: | ||
* Manage facility users through the [[Facility Dashboards|Facility Dashboard]] | * Manage facility users through the [[Facility Dashboards|Facility Dashboard]] | ||
* Reassign “unselected” or misattributed data through the [[Datasets|Dataset Browser]] | * Reassign “unselected” or misattributed data through the [[Datasets|Dataset Browser]] | ||
* Monitor the health of NDTS for their facility, including heartbeats, through the virtual NAN Operating Center (vNOC) | * Monitor the health of NDTS for their facility, including heartbeats, through the virtual NAN Operating Center (vNOC) | ||
== Security == | |||
* Out-of-date operating systems on spectrometer workstations may lack modern encryption. To mitigate this risk, NDTS employs a dedicated '''Gateway''' computer between the workstations and the NDTS '''Receiver'''. The Gateway runs a current Linux distribution, and users are expected to apply security updates promptly. | |||
* Because the Gateway resides on the same internal network as the workstations, dataset transfers from a workstation to the Gateway occur over an unencrypted channel; this local scope generally makes encryption unnecessary. | |||
* All outbound communication originates from the Gateway; NAN datacenter services never initiate connections to facility Gateways. Transfers from the Gateway to the Receiver are fully encrypted, and mutual TLS certificates ensure the Gateway is connected to the correct Receiver. Checksums protect every transmission, and any failed transfer, either (workstation-to-Gateway or Gateway-to-Receiver) is queued locally for automatic retry. | |||
* Upon arrival at the Receiver, each dataset is replicated across two independent storage systems. After ingestion, the data is stored redundantly in two additional locations, each offering high durability. |
Latest revision as of 15:30, 25 June 2025
Navigation of NDTS Documentation
- NAN Data Transport System
- NDTS Overview
- NDTS Installation
- TopSpin 3.x Requirement
- Managing, Monitoring, and Logging
- NDTS Usage Guides
Overview
The Network for Advanced NMR Data Transport System (NDTS) enables automated harvesting of NMR acquisition data from spectrometer workstations and delivers it securely to the NAN Repository. Facility Managers are responsible for installing and managing the local components of the system, ensuring connectivity, and supporting user access to collected data.
NDTS Components
The NDTS system consists of local and central components working together to collect, transfer, store, and index NMR datasets
Component | Location | Role |
---|---|---|
Daemon | Spectrometer Workstation |
|
NDTS GUI | Spectrometer Workstation |
|
Gateway | Within NMR facility network |
|
Receiver | UCHC Data Center |
|
Parser | UCHC Data Center |
|
PostgreSQL Database | UCHC Data Center |
|
Primary Storage | UCHC Data Center |
|
Disaster Recovery Storage | Geo-dispersed |
|
Elasticsearch Database | UCHC Data Center |
|
Data Flow Summary
- A user completes an acquisition on a spectrometer.
- The Daemon detects the completed experiment and sends it to the Gateway.
- The Gateway transmits the data to the Receiver at UCHC.
- The Receiver accepts the data and hands it off to the Parser.
- The Parser extracts metadata and stores it in the PostgreSQL and Elasticsearch databases.
- The experiment data is stored in primary storage and backed up to disaster recovery storage.
- The data becomes visible in the NAN Portal (e.g., Data Browser, vNOC) within seconds.
Failures at any stage result in data being spooled locally and retried automatically.
Facility Manager Responsibilities
Facility Managers are expected to:
- Purchase the Gateway computer and install a modern Linux (preferably Ubuntu / Xubuntu / Mint or other Debian based OS)
- Install and configure Gateway and Daemon software
- Manage facility users through the Facility Dashboard
- Reassign “unselected” or misattributed data through the Dataset Browser
- Monitor the health of NDTS for their facility, including heartbeats, through the virtual NAN Operating Center (vNOC)
Security
- Out-of-date operating systems on spectrometer workstations may lack modern encryption. To mitigate this risk, NDTS employs a dedicated Gateway computer between the workstations and the NDTS Receiver. The Gateway runs a current Linux distribution, and users are expected to apply security updates promptly.
- Because the Gateway resides on the same internal network as the workstations, dataset transfers from a workstation to the Gateway occur over an unencrypted channel; this local scope generally makes encryption unnecessary.
- All outbound communication originates from the Gateway; NAN datacenter services never initiate connections to facility Gateways. Transfers from the Gateway to the Receiver are fully encrypted, and mutual TLS certificates ensure the Gateway is connected to the correct Receiver. Checksums protect every transmission, and any failed transfer, either (workstation-to-Gateway or Gateway-to-Receiver) is queued locally for automatic retry.
- Upon arrival at the Receiver, each dataset is replicated across two independent storage systems. After ingestion, the data is stored redundantly in two additional locations, each offering high durability.