QMetry and Reports Installation on Linux - 2 Tier
This topic describes how to install QMetry Test Management Application and QMetry Reports in a 2-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 - 2 Tier.
For RHEL 8 or RHEL 9 with Podman, see QMetry and Reports Installation on Linux - 2 Tier (RHEL8, RHEL9 & Podman).
Server Roles
The 2-tier deployment uses two Linux servers. The following table lists the role of each server.
2 Tiers | Installations |
|---|---|
Server 1 | QMetry Application and QMetry Database |
Server 2 | QMetry Reports |
Installation Roadmap
To install QMetry in a 2-tier environment, do the following in order:
Confirm the prerequisites.
Install QMetry Application on Server 1.
Install Redis, ActiveMQ, and the Automation API feature. QMetry Reports require Redis and ActiveMQ.
Install QMetry Reports on Server 2.
Prerequisites
Confirm every item in the Pre-requisites for QMetry Application and Reports Server Installation document. After that confirm the following:
Prerequisite | What to confirm |
|---|---|
Operating System | You use RHEL 8, RHEL 9, or RHEL10, or Ubuntu 24.04 (the only supported OS). |
Required commands | unzip, yum and curl are installed on every server. |
Installation files | You have the files |
Security Protocol | Run Application and Reports over the same protocol (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 a non-root install, 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
The following table lists the connections that must be open between the servers:
Component | Ports |
|---|---|
QMetry Application | 80/443, and 3306 |
QMetry Reporting tool | 80/443 |
Reports server to QMetry Application database | 3306 (or your configured database port) |
QMetry Application to Reports server | 8080 and 3306 |
Reports server to Redis | 6379 |
Reports server to ActiveMQ | 61616 and 8181 |
Install QMetry Application
To install QMetry Application do the following:
Copy the
QMetry_Linux_Installer.zipfile to the 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 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/qmetryapp
Enter the configuration parameters
Options
Default Value
Example
Enter QMetry database schema
qmetry
qmetry
Enter QMetry database password for root user
None
QMetry@123
Enter Email for QMetry admin user
None
Enter password for QMetry admin user
None
Admin@123
Enter Min. Heap Memory for the web server in GB
2
2
Enter Max. Heap Memory for the web server in GB
4
4
Enter QMetry Database Connection Pool Size
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
Open a second terminal on the server, and then run the following command to list the installed containers with their IDs and names:
docker ps
In the installer, enter 0 to exit.
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 with the user name admin and the password that you entered in step 7.
Update the administrator profile:
Open the Admin profile, and then click Edit.
In the Email box, enter the email address of the administrator.
In the Base URL box, 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, refer to Additional Configuration.
Note
MySQL runs on port 3306. To connect to it, use the user name root, and the password and schema that you entered in step 7.
Back up the application data directory and the database on a regular schedule.
Install Redis, ActiveMQ, and the Automation API Feature
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 Reports
Prerequisites
Before you install QMetry reports, verify the following requirements.
QMetry Application is installed and running.
In the QMetry administrator profile, configure the Application Base URL using its DNS name or IP address.
The Redis and ActiveMQ containers are running and are configured in QMetry Application.
The reports server can reach the following services: Redis (6379), ActiveMQ (61616 and 8181) QMetry Application (80 and 443), and the QMetry Application database (3306).
Steps for QMetry Reports Installation
To install QMetry Reports on the second server, do the following:
Connect to the reports 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 reports configuration parameter
Options
Details
Example
Enter App Database Host URL
The IP address or DNS name of the server that hosts the QMetry Application database.
10.0.8.166
Enter App Database Port
The port of the QMetry Application database.
3306
Enter App Database Username
The user name of the QMetry Application database.
root
Enter App Database Password
The password of the QMetry Application database that you entered in step 7 of the application installation. Enter the Application database password that you configured during Application installation
root
Enter App Database Schema Name
The schema name of the QMetry Application database.
qmetry
Enter Reports Database Host URL
The IP address or DNS name of the server that hosts the QMetry Reports database.
10.0.8.221
Enter Reports Database Port
The port of the QMetry Reports database.
3306
Enter Reports Database Username
The user name of the QMetry Reports database.
root
Enter Reports Database Password
The password of the QMetry Reports database.
root
Enter Reports Database Schema
The schema name of the QMetry Reports database.
qtmanalytics
Enter MQ URL
The URL of the ActiveMQ server, in the format tcp://<host>:61616.
tcp://10.0.8.166:61616
Enter MQ Username
The ActiveMQ user name that you set when you installed ActiveMQ.
admin
Enter MQ Password
The ActiveMQ password that you set when you installed ActiveMQ.
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. The installer then runs a full synchronization. When the sync is complete, the installer displays the following message:
QMetry Reports installation is complete
In the installer, enter 0 to exit.
Run the following command to verify that the reports containers are running:
docker ps
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 as an administrator, and then select Customizations.
Select Insight Configuration and open Database Configuration tab.
On the Database Configuration tab, enter the following details:
Host: Enter Reports Database Host URL from the reports configuration table.
Port: 3306
Username: <Enter Reports database username>
Password: <Enter Reports database password>
Database Name: <Reports DB schema specified during installation>
Click Test to verify the connection, and then click Test & Save.
Set up the reports data sync
On the Sync Data tab, set up the Reports Data Sync from your reports server to QMetry Reporting.
Reports Server URL: Enter your reports server domain URL followed by port 8080. Confirm that port 8080 is open on the reports 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.
Start using QMetry Reports when the sync is completed. QMetry remains available during this time.
Get support
For any installation issue, raise a ticket on the Support Portal.