QMetry and Reports Installation on Linux - 2 Tier (RHEL 8, RHEL 9, and RHEL 10 & Podman)
This guide describes how to install QMetry Test Management application and QMetry Reports in a 2-tier environment on RHEL, using Podman. In a two-tier deployment, the application and its database run on one server, and the reporting tools run on a second server.
QMetry runs in containers on Apache Tomcat 11.0.5, MySQL 8.4.8, and OpenJDK 17.0.2 as the Java runtime.
Deployemnt Architecture
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 DB |
Server 2 | QMetry Reports |
Prerequisites
Confirm every item in the Prerequisites for QMetry Application and Report Server Installation. For the hardware requirements, see QMetry Deployment Document. Then confirm the following:
Prerequisite | What to confirm |
|---|---|
Operating System | RHEL 8, RHEL 9, and RHEL 10. |
Containers | Podman and Podman Compose must be installed on both servers. Root access is required to install these utilities. |
Installation Package |
|
Internet access | Required on both servers for an online installation. For offline installation, prepare the required container images on an internet-connected machine. |
Proxy | Ensure no proxy or firewall blocks required downloads or server-to-server traffic. |
Server communication | The application and report servers can reach each other on the required ports. |
Security protocol | You run QMetry Application and QMetry Reports on the same protocol, either HTTP or HTTPS. If you integrate with Jira over HTTPS, run QMetry on HTTPS as well. |
To install using a non-root user, refer to Installing QMetry as a Standard User before starting the install on both QMetry and Report servers.
Required Ports
The following table consolidates the ports referenced in this installation workflow.
Installation | Ports that need to be enabled and should be available for use |
|---|---|
QMetry Application | 80/443 & 3306 (8081/443 & 3306 in case of rootless installation) |
QMetry Reports | 80/443, 8081 & 3306 |
Report Server should be able to communicate with Application Server over 80/443 (8081/443 in case of rootless installation) and Database Server 3306/DB Port. Ports 8081 and 3306 should be enabled/open on Reports Server to allow connections from the QMetry application server.
Rootless Installation
For a rootless installation, do the following:
Install Podman and Podman Compose as described in Install Podman and Podman-Compose. You must follow these steps.
To run the installer as a user other than root, see Installing QMetry as a Standard User before you start the installation on both servers.
Use the rootless ports in the table above, and access QMetry Application on port 8081.
Offline Installation
For an offline installation, do the following on a machine with internet access:
Install podman and podman-compose tools. You can follow steps mentioned in the Install Podman and Podman-Compose section to install the tools. However, it is not mandatory to follow these specific guidelines for the installation of the tools.
Download docker images of QMetry products. Refer to Download Docker Images of QMetry Products. Follow these steps on a machine where the internet is accessible so that the docker images can be downloaded on it.
Install Podman and Podman-Compose
To install Podman and Podman Compose, do the following:
It may take some time to install the podman and podman-compose utilities. Please wait until it gets completed.
Copy the installation file that you received from QMetry Support to the server, and extract the zip file. Navigate to the directory where this file is kept and execute the following commands.
unzip QMetry_RHEL_Installer.zip
Run the following commands to install Podman and Podman Compose:
chmod +x install.sh sudo sh install.sh
Run the following commands to verify the installation:
podman --version podman-compose --version
Install QMetry Application
To install QMetry Application, do the following:
For an offline installation, the installer asks for the directory path of each .tar file. For example, if the file is at /opt/qmetrydb.tar, enter /opt.
Username: admin
Password: <user specified password in Step # 7 >
The MySQL 8.4.8 database is installed on port 3306 with the following details.
Username: root
Password: <user specified password in Step # 7 >
Schema: <user specified Schema in Step # 7 >
Note
This installation deploys QMetry over Apache Tomcat 11.0.5, MySQL 8.4.8 and Open JDK 17.0.2 in a docker container.
Copy the
QMetry_RHEL_Installer.zipfile to the server, go to the directory that contains the file, and then run the following command to extract it:unzip QMetry_RHEL_Installer.zip
Run the following commands to start the installer:
cd QMetry_RHEL_Installer sudo su chmod +x install.sh ./install.sh
When the installer asks whether to make an online installation, enter Y for an online installation or N for an offline installation.
Options
Allowed Values
Default Value
Recommended Value
Do you want to make an online installation (Y/N)?
Y, y, N, n
Y
Y
The script runs docker.sh to verify Docker installation and prerequisites are met. Enter container repository credentials shared as a part of the installation package.
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.
Prompt
Example
Please enter QMetry application directory
/opt/QMetry_RHEL_Installer
Enter the configuration parameters.
Options
Details
Default Value
Example
Enter QMetry database schema
QMetryApplication Database schema name.
qmetry
qmetry
Enter QMetry database password for root user
Enter QMetry Application Database Password for the root user.
-
QMetry@123
Enter Email for QMetry admin 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 QMetry Database 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 verify that the containers are running:
podman ps
The output lists the running containers with their IDs and names.
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.
Commercial license: Run the following command to find the MAC address of the Ethernet card, for example eth0 or eth1, and then send the MAC address and the domain name of your server at [email protected] to request your license.
ifconfig
When you receive the license.key file from QMetry Support, see Apply License File - QMetry Tomcat installed on docker.
Open the application in a browser:
http://<IP_address_or_domain_name>
For a rootless installation, use port 8081:
http://<IP_address_or_domain_name>:8081
Log in with the Default QMetry credentials.
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, see Additional Configuration.
Note
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 (RHEL8, RHEL9, RHEL10 and Podman).
Install ActiveMQ and the Automation API feature. For steps, see Install/Upgrade Automation API Feature (RHEL8, RHEL9, RHEL10 & Podman).
Make sure that the Redis and ActiveMQ containers are running and are configured in QMetry Application.
Install QMetry Reports
Note
Reports installation requires Redis Server and ActiveMQ Server. Refer to the Redis and Automation installation sections for setup steps.
Prerequisites
Before you install QMetry Reports, verify the following requirements.
QMetry Application is installed and running.
QMetry Application DNS/IP is configured in profile section.
ActiveMQ and Redis containers are running and configured in QMetry App.
The services are reachable from the report server: Redis (6379), ActiveMQ (61616, 8161), App (80, 443), App DB (3306).
Steps for QMetry Reports Installation
To install QMetry Reports on the second server, perform the following steps:
Connect to the report server, upload the QMetry_RHEL_Installer.zip file to the /opt directory, and then run the following commands to extract it:
sudo su - cd /opt unzip QMetry_RHEL_Installer.zip cd QMetry_RHEL_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 for an online installation or N for an offline installation. For an offline installation, enter the directory path of each .tar file when the installer asks for it.
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 container registry 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 ActiveMQ 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 the server has 8 CPU 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.
Run the following command to verify that the report containers are running:
podman 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 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:
Select the Sync Data tab.
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 after you install QMetry Reports for the first time. The time that the sync takes depends on the amount of data in QMetry. You can monitor sync progress and status in the interface. QMetry custom reports are not accessible while the sync runs. Run the sync only during off-peak hours.
Get support
If you have an installation issue, open a ticket on the Support Portal.