QMetry and Reports Installation on Linux - 3 Tier
This topic describes how to install the QMetry Database, QMetry Application, and QMetry Reports in a 3-tier Linux environment.
QMetry runs in Docker containers on Apache Tomcat 11.0.5, MySQL 8.4.8, and OpenJDK 17.0.2.
Before you begin, choose the topic that matches your environment:
For an offline installation, see QMetry and Reports Offline Installation on Linux - 3 Tier.
For RHEL 8, RHEL 9, or RHEL 10 with Podman, see QMetry and Reports Installation on Linux - 3 Tier (RHEL8, RHEL9, RHEL10 & Podman).
Server Roles
The 3-tier deployment uses three Linux servers. The following table lists the role of each server.
3 Tiers | Installations |
|---|---|
Server 1 | QMetry Application |
Server 2 | QMetry Reports |
Server 3 | QMetry Database |
Prerequisites
Confirm every item in Pre-requisites for QMetry Application and Report Server Installation. Then confirm the following:
Prerequisite | What to confirm |
|---|---|
Operating System | Linux - CentOS 7 and 8, RHEL 8, 9, and 10, Ubuntu 24.04 |
Required commands | unzip, curl, wget, vim and Docker are installed on every server. |
Installation files | You have the |
Security Protocol | Configure both the QMetry application and Reports on the same protocol, either HTTPS or HTTP. If you integrate with Jira over HTTPS, run QMetry on HTTPS as well. Both must use the same protocol. |
Root access | Docker installation requires root user access. For non-root user, refer to Installing QMetry as a Standard User. |
Storage | Docker stores data under /var/lib/ by default; the installer also asks for a QMetry data location. Ensure both directories have enough disk space. |
Required Ports
Open and reserve the following ports for each component. Confirm that ports 80, 443, and 3306 are free and not in use by other applications on their respective servers.
Component | Ports |
|---|---|
QMetry database server | 3306 |
QMetry application | 80/443 |
QMetry Reporting tool | 80/443, 8080, and 3306 |
The application server and the report server can communicate over ports 80 and 443, and with the database server over port 3306 (or your configured database port).
Open ports 8080 and 3306 on the Report server so the Application server can connect.
Confirm the Application server can reach the Report server on port 3306.
Install the QMetry Database
To install the QMetry database, perform the following steps:
Copy the
QMetry_Linux_Installer.zipfile to the database server, go to the directory that contains the file, and then run the following command to extract it:unzip QMetry_Linux_Installer.zip
Run the following commands to start the installer:
cd QMetry_Linux_Installer sudo su chmod +x install.sh ./install.sh
When the installer asks whether to make an online installation, enter Y.
Options
Allowed Values
Default Value
Recommended Value
Do you want to make an online installation (Y/N)?
Y, y, N, n
Y
Y
Enter the Docker credentials that you received from QMetry Support.
At the Main Installation Menu, enter 1 to install the QMetry Database.
Enter the password for the database root user.
Options
Details
Example
Enter QMetry database password for root user
Enter QMetry Application Database Password for the root user.
QMetry@123
Wait for the installation to finish.
Enter 0 to exit the installer.
Run the following command to verify that the database container is running:
docker ps
The output lists a container named qmetryapp_db.
Grant remote access to the root user so that the QMetry Application server and the report server can connect to the database.
docker exec -it qmetryapp_db bash mysql -uroot -p; GRANT ALL PRIVILEGES ON *.* TO 'root'@'%';
Run exit twice to leave the MySQL client and the container shell.
Note
MySQL runs on port 3306. Use the user name root and the password that you entered in step 6 to connect to it.
Install QMetry Application
To install QMetry Application on Server 1, do the following:
Note
Recommended: Back up the application data directory on a regular schedule. Periodic backups help prevent data loss if a disaster occurs.
Copy the
QMetry_Linux_Installer.zipfile to the application server, go to the directory that contains the file, and then run the following command to extract it:unzip QMetry_Linux_Installer.zip
Run the following commands to start the installer:
cd QMetry_Linux_Installer sudo su chmod +x install.sh ./install.sh
When the installer asks whether to make an online installation, enter Y.
Options
Allowed Values
Default Value
Recommended Value
Do you want to make an online installation (Y/N)?
Y, y, N, n
Y
Y
Enter the Docker credentials that you received from QMetry Support. The installer runs docker.sh to verify the Docker installation and the prerequisites.
At the Main Installation Menu, enter 2 to install QMetry Application.
Enter a directory path on the host machine to store QMetry data, such as attachments, licenses, imports, and exports. You can enter any valid path. If the directory does not exist, the installer creates it.
Options
Example
Please enter QMetry application directory
/opt/QMetry_Linux_Installer
Enter the configuration parameters. For the database host, enter the IP address or DNS name of Server 3, not localhost.
Options
Details
Default Value
Example
Enter QMetry database hostname
Enter QMetry Database Host as DNS/IP Address
localhost
192.168.0.100
Enter the QMetry database port
Enter QMetry Database Port. If it is unchanged, use "3306" as the Database port.
3306
3306
Enter QMetry database schema
QMetryApplication Database schema name.
qmetry
qmetry
Enter QMetry database username
Enter the Database's Username.
-
root
Enter QMetry database password for root user
Enter QMetry Application Database Password for the root user.
-
QMetry@123
Enter Email for QMetryadmin user
Enter QMetry user email address for Admin.
-
Enter password for QMetry admin user
Enter QMetry user password for Admin.
-
Admin@123
Enter Min. Heap Memory for the web server in GB
Enter Heap Memory in GB
2
2
Enter Max. Heap Memory for the web server in GB
Enter Heap Memory in GB
4
4
Enter QMetryDatabase Connection Pool Size
Enter Pool Size in number format
100
100
Wait for the installation to finish. This may take some time. When the installation is complete, the installer displays the following message:
QMetry Application Installation is complete
Enter 0 to exit the installer.
Run the following command to list the installed containers with their IDs and names:
docker ps
Apply your license. Use the option that matches your license type:
Evaluation license: Use the evaluation license that you received with the installation. It is valid for 30 days. For steps, see Apply License File - QMetry Tomcat installed on docker.
Commercial license: Run the following command to find the MAC address of your server, and then email the MAC address and the domain name of your server to QMetry Support.
ifconfig
Open the application in a browser:
http://<IP_address_or_domain_name>
Log in using the database credentials and schema configured during database/Application setup.
The Application connects to the MySQL database on Server 3 over port 3306.
Update the administrator profile
Go to Admin Profile and click Edit.
In the Email box, enter the email address of the administrator.
In the Base URL field, enter your QMetry URL.
Click Update.
Optional: Configure additional Tomcat settings. QMetry installs with default values for minimum and maximum heap memory. You can change them to match your hardware. For details, see Additional Configuration.
Note
QMetry Application connects to the MySQL database on Server 3 with the user name and password that you set when you installed the database.
Install Redis, ActiveMQ, and the Automation API Feature
If you use QMetry Reports, install the following components before you install QMetry Reports. QMetry Reports require the Redis server and the ActiveMQ server. The Automation API feature also adds automation API capabilities to on-premises QMetry installations, including faster import of automation result files.
To install these components, do the following:
Install the Redis server. For steps, see Installing Redis Caching Server for Online Installations.
Install ActiveMQ and the Automation API feature. For steps, see Install and Upgrade Automation API Feature for Online Installations.
Make sure that the Redis and ActiveMQ containers are running and are configured in QMetry Application.
Install QMetry Report
Install QMetry Reports on Server 2 only if you purchased Advanced Reporting.
Prerequisites
Before you install QMetry reports, verify the following:
QMetry App is installed and running.
QMetry Application URL is set in the Base URL box of the administrator profile.
The Redis and ActiveMQ containers are running and are configured in QMetry Application.
The services are reachable from the report server: Redis (6379), ActiveMQ (61616, 8161), App (80, 443), App DB (3306).
Steps for QMetry Report Installation
To install QMetry Reports on the server 2, do the following:
Connect to the report server, upload the
QMetry_Linux_Installer.zipfile to the /opt directory, and then run the following commands to extract it:sudo su - cd /opt unzip QMetry_Linux_Installer.zip cd QMetry_Linux_Installer/
Run the following commands to start the installer:
chmod +x install.sh ./install.sh
When the installer asks whether to make an online installation, enter Y.
Options
Allowed Values
Default Value
Recommended Value
Do you want to make an online installation (Y/N)?
Y, y, N, n
Y
Y
Enter the Docker credentials that you received from QMetry Support.
At the Main Installation Menu, enter 3 to install QMetry Reports.
Enter the report configuration parameters.
Options
Details
Example
Enter App Database Host URL
Enter Database Host Public IP/DNS of QMetry application.
10.0.8.166
Enter App Database Port
Enter Database Port of QMetry application.
3306
Enter App Database Username
Enter Database username of QMetry application.
root
Enter App Database Password
Enter Database password of QMetry application.
root
Enter App Database Schema Name
Enter Database schema name of QMetry application.
qmetry
Enter Report Database Host URL
Enter Database Host Public IP/DNS of QMetry Report.
10.0.8.221
Enter Report Database Port
Enter Database Port of QMetry Report Database.
3306
Enter Report Database Username
Enter Database username of QMetry Reports Database.
root
Enter Report Database Password
Enter Database password of QMetry Reports Database.
root
Enter Report Database Schema
Enter Database schema name of QMetry Reports Database.
qtmanalytics
Enter MQ URL
Enter MQ Active URL
tcp://10.0.8.166:61616
Enter MQ Username
Enter MQ Username
admin
Enter MQ Password
Enter MQ Password
admin
Enter maximum memory to allocate for CDC app in GB
Maximum memory allocation for the CDC container:
Entered memory would be used by the sync job while running full sync of data.
Enter 25% of total memory available on the server. For example, if the memory on the server is 24 GB, enter 6.
A minimum of 4 GB memory must be allocated.
To check the total memory, run the command: free -h
4
Enter maximum memory to allocate for Sync app in GB
Maximum memory allocation for the Sync container:
Entered memory would be used by the sync job while running full sync of data.
Enter 70% of total memory available on the server. For example, if the memory on the server is 24 GB, enter 17.
A minimum of 8 GB of memory must be allocated.
To check the total memory, run the command: free -h
4
Enter number of CPUs to allocate for CDC app
Number of CPUs to allocate for the CDC container. (The default is 4)
4
Enter number of CPUs to allocate for Sync app
Number of CPUs to allocate for the Sync container:
Allocate 70% of the available CPUs. For example, if CPU has 8 cores, enter 6.
A minimum of 4 CPU cores must be allocated.
To check total CPUs, run the command : lscpu
4
Wait for the containers to be created. QMetry then runs a full sync. When the installer finishes, it displays the following message:
QMetry Report installation is complete
Enter 0 to exit the installer.
In QMetry, open your profile, and then enter the QMetry Application URL in the Base URL box.
Configure the database connection
Log in to QMetry with administrator credentials and go to Customizations.
Select Insight Configuration and open Database Configuration tab.
Under Database Configuration tab, enter the following details:
Host: Enter Report Database Host URL from the report configuration table.
Port: 3306
Username: <Enter Report database username>
Password: <Enter Report database password>
Database Name: <Report DB schema specified during installation>
Select Test to confirm a successful connection, and then select Test & Save.
Set up the report data sync
On the Sync Data tab, set up the Report Data Sync from your reports server to QMetry Reporting.
Report Server URL: Enter your report server domain URL followed by port 8081. Confirm that port 8081 is open on the report server.
Select Test to confirm a successful connection and then select Test & Save.
Note
Run Sync Data once, right after you install QMetry Reports. The sync time depends on the amount of data. Custom reports are unavailable while the sync runs, so run it during off-peak hours. QMetry remains available. You can use QMetry Reports after the sync completes.
Get support
If you encounter issues during installation, create a support ticket in the Support Portal.