1. Overview
This document describes the automated deployment process for the DataTrust application using the DataTrust.ps1 script on a Windows server.
The script performs the following tasks :
- Installs Java 21 (if not already installed) and Dotnet 9.0.3 (if not already installed)
- Validates the license for installation
- Updates the following configuration files:
- appsettings.json
- rightdata.properties
- Nginx.conf
- user.env
- Deploys database schemas (Metadata and Datastore databases)
2. Prerequisites
2.1 System Requirements
- Operating System: Windows (Windows Server 2022 Datacenter Edition or later)
- CPU: Minimum 16 cores (recommended)
- RAM: Minimum 64 GB (recommended)
- Disk Space: At least 500 GB free
- Network: Active internet connection
2.2 SSL Certificate Requirements
To enable secure HTTPS access for the DataTrust application, SSL certificate files must be placed in C:\Certs.
- Create Certificate Directory in C-Drive : (Ex: C:\Certs)
- Place SSL Certificate files into the C:\Certs folder:
.crt file (SSL Certificate)
.key file (Private Key)
Important Notes:
- Ensure the certificate and key files are valid and correspond to the configured domain name.
- File names should not contain spaces.
- Do not place any additional or unrelated files in the C:\Certs folder. Only the required .crt and .key files should be present.
2.3 Database & Port Requirements
Database Requirements
- Two Microsoft SQL Server databases must be created
- Metadata DB used for storing test scenario config details → Example: rd_metadata (recommended)
- Datastore DB used for storing results → Example: rd_datastore (recommended)
- Create a SQL user (not a service account)
- Username: rightdata (recommended)
- Permissions: System admin privileges on both databases
Ports to be open and allow access
- On the VM - 80 (standard http port), 443 (standard https port)
- On the SQL Server - 1433 (standard SQL port) or any other port used.
Other ports on the VM which need to be open for various components of the software but not needed to allow access from outside the VM -
| Services | Ports |
|---|---|
| DataTrust Web App | 5000 |
| Middleware App | 9090 |
| Middleware Utils Service | 9095 |
| Python Service | 5010 |
| RightSight App | 9091 |
| Grafana Service | 3000 |
| Apache Drill Web Console | 8047 |
| Apache Drill Server | 31010 |
2.4 Other Information
- License provided by RightData must be entered during installation.
- All details except passwords must be entered in the user.env file.
- Passwords are required to be entered during the installation.
- Ensure database servers are reachable before starting the installation
- Verify firewall rules allow required ports
- Do not interrupt the script during execution
2.5 Access Requirements
- Administrator privileges on the target machine
3. Deployment Steps
Step 1: Obtain the deployment package DataTrust.zip from the RightData team.
- Extract the Package DataTrust.zip
Step 2: Open the Unzipped Package/Folder DataTrust
Step 3: Update user.env configuration File
Open user.env
# Application Configuration
DOMAIN_NAME=datatrust.example.com (Desired domain to access application)
FRONTEND_DB_IP=
FRONTEND_DB_NAME=
FRONTEND_DB_USER=
FRONTEND_DB_PASSWORD=DO NOT ENTER HERE
MIDDLEWARE_DB_IP=
MIDDLEWARE_DB_NAME=
MIDDLEWARE_DB_USER=
MIDDLEWARE_DB_PASSWORD=DO NOT ENTER HERENote: Passwords should NOT be entered here. It will be prompted during installation.
Step 4: Run installation script
- Open Windows PowerShell – Run as Administrator
=>Navigate to Package cd C:\Users\xyzuser\Downloads\DataTrust\
Run: .\DatatTrust.ps1 (Command to Execute Powershell Script) - During execution:
The script will ask you to enter the License provided by Rightdata, Please enter the license when prompted.
It will also ask for Installation path, please select the path where you want to install DataTrust.
- You will first be prompted to select your database location/type (as shown in the image), such as:
- On-Premise SQL Server
- Azure SQL
- AWS RDS SQL Server
You will then be prompted to enter the database passwords.
- After successful password validation, it will start the installation.
3.1 Installation Time
The installation process typically takes 15–20 minutes depending on system performance.
4. Post-Installation Steps
- After installation is completed, restart the Nginx using windows services.
Once restarted, access the DataTrust application using the configured domain: https://<DOMAIN_NAME>
5. Basic Validation & Troubleshooting
Open Windows Services and make sure the below services are up and running.
- dtwebapp
- dtmiddleware
- nginx