1. Overview
This document describes the automated deployment process for the DataTrust application using the Datatrust.sh script on a Linux system with internet access.
The script performs the following tasks:
- Validates the license for installation
- Updates configuration files:
- appsettings.json
- rightdata.properties
- nginx.conf
- python.env
- user.env
- Deploys database schemas (Middleware and Frontend databases)
- Installs and configures AWS CLI
- Installs Docker and Docker Compose
- Authenticates with AWS ECR and deploys containers
2. Prerequisites
2.1 System Requirements
- Operating System: Ubuntu 20.04 or later
- CPU: Minimum 16 cores (recommended)
- RAM: Minimum 64 GB (recommended)
- Disk Space: At least 500 GB free
- Network: Active internet connection
- Ensure unzip is installed on the server: sudo apt install unzip -y
2.2 SSL Certificate Requirements
To enable secure HTTPS access for the DataTrust application, SSL certificate files must be placed in /home/ubuntu/certs
- Create cert Directory in /home/ubuntu/ (Ex: mkdir /home/ubuntu/certs)
- Place Certificate Files
Copy the SSL files into the /home/ubuntu/certs:
- .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 /home/ubuntu/certs. 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 server - 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 server which need to be open for various components of the software but not needed to allow access from outside the server -
| 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
- SSL certificate files (.crt and .key) to be placed in /home/ubuntu/certs/
- 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
- Root or sudo privileges on the target machine
3. Deployment Steps
Step 1: Download the deployment package using the download link provided by the RightData team.
Execute the following command from the /opt directory to download the package:
cd /opt
wget -O DataTrust.zip "https://example.com/file.zip"
Step 2: Unzip the Package and Navigate to Deployment Directory
unzip DataTrust.zip
cd /opt/DataTrust/
Step 3: Update Configuration File
vi 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 HERE
Note: Passwords should NOT be entered here. It will be prompted during installation.
Step 4: Switch to root user
- sudo su
Step 5: Run installation script
- ./DataTrust.sh
During execution:
You will first be prompted to select your database location/type (as shown in the image), such as:
- On-Premises SQL Server
- Azure SQL
- AWS RDS SQL Server
- You will then be prompted to enter the database passwords.
- After successful password validation, you will be prompted to enter the License provided by the RightData team.
3.1 Installation Time
The installation process typically takes 20–30 minutes depending on system performance and network speed.
4. Post-Installation Step (SSL Configuration)
- Restart the Nginx container:
- docker restart nginx
- Once restarted, access the DataTrust application using the configured domain: https://<DOMAIN_NAME>
5. Basic Validation & Troubleshooting
5.1 Basic Validation
- docker ps -a
5.2 Troubleshooting
- docker logs <container_name>
- docker restart <container_name>