NDTS Installation: Difference between revisions

From Network for Advanced NMR
Jump to navigationJump to search
← Older editNewer edit →
VisualWikitext
No edit summary
Line 3: Line 3:
= Installing and Updating Daemon and Gateway =
= Installing and Updating Daemon and Gateway =


This page explains how to install, update, uninstall, and roll back the two local NDTS components:
This page walks Facility Managers through installing, updating, uninstalling, and rolling back the two local NDTS components:
* The '''Daemon''' – installed on each spectrometer workstation
* The '''Gateway''' – installed on a facility-level server


These components are responsible for harvesting experiment data and transferring it securely to the NAN Repository.
* '''Gateway''' – a facility-level server that receives data from all workstations 
* '''Daemon''' – runs on every spectrometer workstation


== '''Acquiring Installation Packages''' ==
Packages are provided as ``*.tar.gz`` archives on the Facility Dashboard.
Installation packages are provided as `.tar.gz` archives and are available for [[Download Software|download]] from the Facility Dashboard.


If a package is missing or access is restricted, submit a support ticket to the NAN Repository team.
== '''Gateway Installation''' ==


== '''Gateway Installation''' ==
=== Prerequisites ===
=== Prerequisites ===
Before beginning installation:
* A **Gateway UUID** supplied by the NAN Repository administrator 
* Obtain a '''Gateway UUID''' from the NAN support team
* A Linux host (Ubuntu 20.04 recommended) reachable by all workstations 
* Use a dedicated Linux machine (Ubuntu 20.04 or later recommended)
* TCP **port 60195** open inbound from those workstations
* Ensure TCP port '''60195''' is open to NDTS spectrometer workstations


=== Installation Steps ===
=== Steps ===
<pre>
<pre>
# Copy the .gz archive to the gateway system
# Copy the .gz file to the gateway computer
tar xf filename
tar xf data-transport-gateway-<version>.tar.gz
cd dtgateway-installer
cd dtgateway-installer
sudo ./install.sh
sudo ./install.sh
# When prompted:
# → You will be prompted only for the Gateway UUID
#  Enter the Gateway UUID
</pre>
</pre>


=== Post-Installation ===
=== Firewall Note ===
Open port 60195 to each NDTS workstation; no other inbound ports are required.
 
=== Verifying the Service ===
<pre>
<pre>
# Check if the gateway is running
sudo systemctl status data-transport-gateway     # should show “active (running)”
sudo systemctl status data-transport-gateway
sudo systemctl start data-transport-gateway     # start if not running
 
# If needed, start the service
sudo systemctl start data-transport-gateway
</pre>
</pre>


=== Updating the Gateway ===
=== Updating the Gateway ===
Re-run the same installer script with the newer package:
<pre>
<pre>
# Run the same installer script from a newer package
cd dtgateway-installer
cd dtgateway-installer
sudo ./install.sh
sudo ./install.sh             # auto-detects an existing install; no prompts
# No prompts are shown during update
</pre>
</pre>


=== Uninstalling the Gateway ===
=== Uninstalling the Gateway ===
<pre>
<pre>
# Run the uninstall script included in the archive
sudo ./uninstall.sh           # script is included inside every package
sudo ./uninstall.sh
</pre>
</pre>


=== Rolling Back the Gateway ===
=== Rolling Back the Gateway ===
<pre>
Obtain the desired older package and run its ``install.sh``. 
# Use the older version’s installer to roll back
Rolling back more than one or two versions is not recommended.
tar xf old-version.tar.gz
 
cd dtgateway-installer
----
sudo ./install.sh
 
</pre>
== '''Daemon Installation (Workstation)''' ==


== '''Daemon Installation (Spectrometer Workstation)''' ==
=== Prerequisites ===
=== Prerequisites ===
* IP address of the Gateway
1. **Gateway IP address** 
* Exact instrument name (as entered in the [[Spectrometers]] section of the Facility Dashboard)
2. Exact **Instrument Name** (set in the Facility Dashboard – no spaces)
* Workstation UUID (from the [[Spectrometers]] section of the Facility Dashboard)
3. **Workstation UUID** (generated when the spectrometer was added)
* For AlmaLinux, ensure `chkconfig` is installed


=== Installation Steps ===
*AlmaLinux only:* install ``chkconfig`` before proceeding.
 
=== Steps ===
<pre>
<pre>
# Copy the .gz archive to the workstation
# Copy the .gz file to the workstation
tar xf filename
tar xf data-transport-daemon.<distro>-<version>.tar.gz
cd dtdaemon-installer
cd dtdaemon-installer
sudo ./install.sh
sudo ./install.sh
# When prompted:
# → Prompts:
#  Enter Gateway IP address
#  • Gateway IP address
#  Enter instrument name (e.g., nmr600)
#  • Instrument name (e.g., nmr600)
#  Enter workstation UUID
#  • Workstation UUID
</pre>
</pre>


=== Updating the Daemon ===
=== Updating the Daemon ===
<pre>
<pre>
# Run the same install script
# Best practice: ensure no acquisition is running and the UI is closed
cd dtdaemon-installer
cd dtdaemon-installer
sudo ./install.sh
sudo ./install.sh             # updates binaries and restarts the daemon
 
# Note:
# - Best to update when no acquisition is running
# - The installer will close any running UI automatically
</pre>
</pre>


=== Uninstalling the Daemon ===
=== Uninstalling the Daemon ===
<pre>
<pre>
# Run the uninstall script
sudo ./uninstall.sh
sudo ./uninstall.sh
</pre>
</pre>
Line 100: Line 88:
=== Rolling Back the Daemon ===
=== Rolling Back the Daemon ===
<pre>
<pre>
# Use the older install package
tar xf data-transport-daemon.<distro>-<old-version>.tar.gz
tar xf old-version.tar.gz
cd dtdaemon-installer
cd dtdaemon-installer
sudo ./install.sh
sudo ./install.sh             # not advised to roll back >2 versions
</pre>
 
== '''Managing the Daemon Service''' ==
The daemon uses **SysV service scripts** for maximum compatibility:
<pre>
sudo /sbin/service data-transport-daemon start
sudo /sbin/service data-transport-daemon stop
sudo /sbin/service data-transport-daemon restart
sudo /sbin/service data-transport-daemon status
</pre>
</pre>


== '''Next Step: Configure the Daemon''' ==
== '''What’s Next?''' ==
Once installation is complete, continue with: [[NDTS_Daemon_Configuration|Configuring the Daemon]]
* [[NDTS_Daemon_Configuration|Configuring the Daemon]]
* [[NDTS_Daemon_Operation|Running and Monitoring the Daemon]]

Revision as of 18:48, 2 June 2025

← Back to NAN Data Transport System Overview

Installing and Updating Daemon and Gateway

This page walks Facility Managers through installing, updating, uninstalling, and rolling back the two local NDTS components:

  • Gateway – a facility-level server that receives data from all workstations
  • Daemon – runs on every spectrometer workstation

Packages are provided as ``*.tar.gz`` archives on the Facility Dashboard.

Gateway Installation

Prerequisites

  • A **Gateway UUID** supplied by the NAN Repository administrator
  • A Linux host (Ubuntu 20.04 recommended) reachable by all workstations
  • TCP **port 60195** open inbound from those workstations

Steps

# Copy the .gz file to the gateway computer
tar xf data-transport-gateway-<version>.tar.gz
cd dtgateway-installer
sudo ./install.sh
# → You will be prompted only for the Gateway UUID

Firewall Note

Open port 60195 to each NDTS workstation; no other inbound ports are required.

Verifying the Service

sudo systemctl status data-transport-gateway      # should show “active (running)”
sudo systemctl start  data-transport-gateway      # start if not running

Updating the Gateway

Re-run the same installer script with the newer package: 

cd dtgateway-installer
sudo ./install.sh             # auto-detects an existing install; no prompts

Uninstalling the Gateway

sudo ./uninstall.sh           # script is included inside every package

Rolling Back the Gateway

Obtain the desired older package and run its ``install.sh``. Rolling back more than one or two versions is not recommended.

Daemon Installation (Workstation)

Prerequisites

1. **Gateway IP address** 2. Exact **Instrument Name** (set in the Facility Dashboard – no spaces) 3. **Workstation UUID** (generated when the spectrometer was added)

  • AlmaLinux only:* install ``chkconfig`` before proceeding.

Steps

# Copy the .gz file to the workstation
tar xf data-transport-daemon.<distro>-<version>.tar.gz
cd dtdaemon-installer
sudo ./install.sh
# → Prompts:
#   • Gateway IP address
#   • Instrument name  (e.g., nmr600)
#   • Workstation UUID

Updating the Daemon

# Best practice: ensure no acquisition is running and the UI is closed
cd dtdaemon-installer
sudo ./install.sh              # updates binaries and restarts the daemon

Uninstalling the Daemon

sudo ./uninstall.sh

Rolling Back the Daemon

tar xf data-transport-daemon.<distro>-<old-version>.tar.gz
cd dtdaemon-installer
sudo ./install.sh              # not advised to roll back >2 versions

Managing the Daemon Service

The daemon uses **SysV service scripts** for maximum compatibility: 

sudo /sbin/service data-transport-daemon start
sudo /sbin/service data-transport-daemon stop
sudo /sbin/service data-transport-daemon restart
sudo /sbin/service data-transport-daemon status

What’s Next?

Retrieved from "https://wiki.usnan.org/index.php?title=NDTS_Installation&oldid=557"