QMetry and Reports Installation on Linux - 3 Tier (RHEL8 & Podman)
In this guide, we'll run you through installing QMetry Database, QMetry Test Management application, and QMetry Reporting Tool in a 3 Tier Architecture.
3 Tier Install
| Server 1 | QMetry App |
| Server 2 | QMetry DB |
| Server 3 | QMetry Reports |
Pre-requisites
For additional information on verifying pre-requisites refer this article. This installation installs QMetry over Apache Tomcat 10.x, MySQL v8.0.33, and Open JDK 17.0.2 in a podman container.
- This documentation is for the installation of QMetry and Reports only on RHEL8 OS.
- Three Linux Servers are required: QMetry Database, QMetry Application, and QMetry Reporting tool. These three servers should be on the same network and able to communicate with each other. Refer QMetry Deployment Document for the requirements. All the servers should have the support of these commands: unzip, wget, curl, and vim.
- Internet access should be enabled on all 3 servers to install using podman, in case of online installation.
- Ensure Proxy Servers are not blocking downloads from the Internet.
- Application, DB, and Report servers should be in the same network. QMetry and Report Servers should be able to communicate over 80/443 (8080/443 in case of rootless installation) and Database Server 3306/DB Ports. Ports 8080 and 3306 should be enabled/open on Reports Server to allow connections from QMetry application server.
- The ports 80/443 and 3306 on the respective servers should be free and should not be in use by other applications. QMetry App server should be able to communicate with the reports server on port 3306.
- Podman and podman-compose utilities should be installed using root user.
- Get the following files from QMetry Support : QMetryApp.zip, QMetryRDS.zip, QMetryReport.zip and container repository credentials required for installation. Post-installation, QMetry Application and Report tool both should be configured either on https or http.
- If you are planning Jira integration with QMetry and Jira is running on https, make sure your QMetry is also running over https protocol. QMetry and Jira should run on the same protocol.
- Following Ports should be open:
| Installation | Ports that need to be enabled |
|---|---|
| QMetry Database Server | 3306 |
| QMetry Application | 80/443 (8080/443 in case of rootless installation) |
| QMetry Reporting Tool | 80/443, 8080, & 3306 |
Before you proceed with the installation
In case of offline installation
Step 1. Install podman and podman-compose tools. You can follow steps mentioned in the Podman and Podman-Compose Installation section to install the tools. However, it is not mandatory to follow these specific guidelines for the installation of the tools.
Step 2. 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.
Step 3. Restore the docker images of QMetry products on specific machine where the installation is to be carried out.
Refer to Restore Docker Images of QMetry Products.
In case of rootless installation
Note: It is mandatory to follow the steps mentioned for Podman and Podman-Compose Installation.
Install QMetry DB
Follow the steps mentioned below.
Step 1. Copy the QMetryRDS.zip file received from QMetry Support to your database server. Navigate to the directory where this file is kept and execute the following commands.
- sudo su (applicable only for installation using root user)
- unzip QMetryRDS.zip
- cd QMetryRDS
- chmod +x qmetry.sh
- sh qmetry.sh
The next question during the installation process will be as follows.
Options | Allowed Values | Default Value | Comments |
|---|---|---|---|
| Do you want to make an online installation (Y/N)? | Y, y, N, n | Y | To begin the online installation, enter "Y". To begin the offline installation, enter "N". |
Then you will be asked for credentials. Enter container repository credentials shared as a part of the installation package.
Step 2. Once the script finishes executing, it will prompt to enter the following parameters:
| Options | Details | Example |
|---|---|---|
| Enter QMetry database password for root user | Enter QMetry Application Database Password for the root user. | QMetry@123 |
After successful installation of QMetry DB, you will see the message "QMetry RDS Installation is complete".
Install QMetry Application
Follow the steps mentioned below.
Step 1. Copy the QMetryApp.zip received from QMetry Support to your application server. Navigate to the directory where this file is kept and execute the following commands.
- sudo su (applicable only for installation using root user)
- unzip QMetryApp.zip
- cd QMetryApp
Step 2. Execute the following command.
- chmod +x qmetry.sh
- sh qmetry.sh
The next question during the installation process will be as follows.
Options | Allowed Values | Default Value | Comments |
|---|---|---|---|
| Do you want to make an online installation (Y/N)? | Y, y, N, n | Y | To begin the online installation, enter "Y". To begin the offline installation, enter "N". |
Then you will be asked for credentials. Enter container repository credentials shared as a part of the installation package.
Step 3. Next, the installation process will prompt for directory path on the host machine to store QMetry application’s file related data like attachments, license, import, export files etc. You can enter any path of the host machine to store QMetry application’s file related data. If the mentioned directory does not exist on the given path, it will get created automatically during the installation process.
Options | Comments/Example |
|---|---|
| Please enter QMetry application directory | /opt/qmetryapp |
Note: It is highly recommended to take periodic backup of the directory which is specified as a location to store QMetry application’s file related data to prevent any data loss in case of any disaster.
Step 4. Once the script finishes executing, it will prompt to enter the following parameters:
Options | Details | Default Value | Example |
Enter QMetry database hostname | Enter QMetry Database Host as DNS/IP Address | localhost | 192.168.0.100 |
Enter QMetry database port | Enter QMetry Database Port. If it is unchanged, use "3306" as the Database port. | 3306 | 3306 |
Enter QMetry database schema | QMetry Application Database schema name. | qmetry | qmetry |
| Enter QMetry database username | Enter Database's Username. | - | root |
Enter QMetry database password | Enter QMetry Application Database Password for the above mentioned username. | - | 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(s) | 2 | 2 |
Enter Max. Heap Memory for the web server in GB | Enter Heap Memory in GB(s) | 4 | 4 |
Enter QMetry Database Connection Pool Size | Enter Pool Size in number format | 100 | 100 |
The installation may take a while.
After successful installation of QMetry Application, you will see the message "An installation of QMetry application has been completed."
Once the installation is complete, execute the following command.
- podman ps
.png?version=1&modificationDate=1708334232094&cacheVersion=1&api=v2)
Step 5. Getting your QMetry License and Installing it.
- For users evaluating QMetry
- You should have received an evaluation license valid for 30 days along with the installation.
- For users requiring a commercial license
- Server's domain name and mac address are required to generate your QMetry License. Follow the below steps to get your server mac address and send this information along with the domain name to QMetry Support to get your QMetry License generated. Send an email to qtmprofessional@qmetrysupport.atlassian.net to reach QMetry Support.
- Execute the below command to get your server mac address. Then send the MAC address to QMetry Support to receive the license file.
- ifconfig (MAC address of Ethernet card e.g. eth0/eth1 )
- Once you receive license.key from QMetry Support, you can follow the Steps to Apply License file.
- Execute the below command to get your server mac address. Then send the MAC address to QMetry Support to receive the license file.
- Server's domain name and mac address are required to generate your QMetry License. Follow the below steps to get your server mac address and send this information along with the domain name to QMetry Support to get your QMetry License generated. Send an email to qtmprofessional@qmetrysupport.atlassian.net to reach QMetry Support.
Step 6. Access the QMetry application using the following address.
http://<your IP Address OR Domain Name>
http://<your IP Address OR Domain Name>: 8080 (in case of rootless installation of QMetry)
Default QMetry login credentials.
- Username: admin
- Password:<user specified password in Step#4>
Note : With installation, MySQL 8.0.33 will be installed on port 3306. Below are the details
- Username : root
- Password : <user specified password in Step#4>
- Schema : <user specified Schema in Step#4>
Note : This installation installs QMetry over Apache Tomcat 10.x, MySQL 8.0.33 and Open JDK 17.0.2 in a podman container.
Step 7. After the above steps are completed, log into QMetry application.
- Go to "Admin" Profile and Edit the Profile.
- Update Email of Admin in the Email field.
- Enter the Base URL as your QMetry URL.
Step 8. Additional Tomcat Configuration: QMetry is installed with a default configuration of minimum and maximum heap memory utilization. You can modify these settings depending on your hardware configuration. Refer Additional Configuration for more details.
Install QMetry Report
If you have purchased Advanced Reporting then you will need a separate server for QMetry Reporting.
Follow the steps mentioned below.
Step 1. Connect to Report Server and Download the file.
Upload the QMetryReport.zip to the /opt directory of the Report server and unzip it.
- sudo su - (applicable only for installation using root user)
- cd /opt
- unzip QMetryReport.zip
- cd QMetryReport/
Step 2. Run the reports installer file.
- chmod +x qmetry.sh
- sh qmetry.sh
The next question during the installation process will be as follows.
Options | Allowed Values | Default Value | Comments |
|---|---|---|---|
| Do you want to make an online installation (Y/N)? | Y, y, N, n | Y | To begin the online installation, enter "Y". To begin the offline installation, enter "N". |
Then you will be asked for credentials. Enter container repository credentials shared as a part of the installation package.
Step 3. Once the installation initiates, it will prompt to enter the following parameters:
| Options | Details | Default Value | Example |
|---|---|---|---|
| Enter Report database password for root user | Enter password for QMetry Reports Database. | - | QMetryreports@!Nf0# |
| Enter Report database schema | Enter Database schema name for QMetry Reports Database. | qtmanalytics | qtmanalytics |
| Enter Number of CPU's to allocate | Allocate 3/4th of the available CPUs. For example, if CPU has 8 cores, enter 6 To check total CPUs, run the command : lscpu | 4 | 6 |
| Enter Memory to allocate in GB(s) | Entered memory would be used by the sync job while running full sync of data. Enter 3/4th of total memory available on the server. For example, if the memory on the server is 24 GB, enter 18 | 4 | 18 |
Wait for the script file to finish executing.
Once the script finishes executing it will prompt to enter the following parameters.
| Options | Details | Example |
|---|---|---|
Enter Mysql Database Host IP / DNS Name (Qmetry) | Enter Database Host IP/DNS of QMetry application. | 10.10.11.100 |
Enter Mysql Database Port (Qmetry) | Enter Database Port of QMetry application. If it is unchanged, use "3306" as Database port. | 3306 |
Enter Mysql Database Schema (Qmetry) | Enter Database schema name of QMetry application. | qmetry |
Enter Mysql Database Username (Qmetry) | Enter Database username of QMetry application. If it is unchanged, use "root" as username. | root |
Enter Mysql Database Password (Qmetry) | Enter Database password of QMetry application. | QMetry@123 |
Enter Mysql Database Host IP / DNS Name (Reports) | Enter Database Host IP/DNS of QMetry Report. | 10.10.11.101 |
Enter Mysql Database Port (Reports) | Enter Database Port of QMetry Report Database. | 3306 |
Enter Mysql Database Schema (Reports) | Enter Database schema name of QMetry Reports Database. | qtmanalytics |
Enter Mysql Database Username (Reports) | Enter Database username of QMetry Reports Database. If it is unchanged, use "root" as username. | root |
Enter Mysql Database Password (Reports) | Enter Database password of QMetry Reports Database. | QMetryreports@!Nf0# |
Enter Port To Start SyncJob (Reports) | Reports Sync Job runs from this port - 8080 | 8080 |
Do you want to Run Force Sync Now? (y/n) | Enter y to sync all the QMetry data to Reports Database with the current script. → Always enter y at the time of fresh reports install | y |
Enter Memory to allocate in GB(s) to Spark | Entered memory would be used by the sync job while running full sync of data. Enter 3/4th of total memory available on the server. For example, if the memory on the server is 24 GB, enter 18 | 18 |
After successful installation of QMetry Report, you will see the message "QMetry Report Installation is complete".
Note: In cases when you need to force sync to re-sync any missing data, just repeat step 3, and skip all parameter details (by hitting enter) and just enter y when prompted for a force sync.
Wait for the script to finish executing.
After waiting for about a minute, command podman ps should return the following:
Step 4. Login to QMetry with 'admin' user login, and configure the reports server URL in the configuration menu
Go to QMetry > Customization > Insight Configuration
- Under Database Configuration tab
- Enter Host: Reports Server Host IP/DNS
- Enter Port: 3306
- Enter Username: root
- Enter Password: <user specified password in Step#3>
Enter Database Name: <user specified name in Step#3>
Click Test to ensure a successful connection and then hit "Test & Save".
- Under Sync Data tab, setup the Report Data Sync from your reports server to QMetry Reporting.
- Report Server URL : This should be set to your report server domain URL followed by port 8080 as shown below. Ensure port 8080 is open on the reports server.
- Click on Test to ensure successful connection and then hit "Test & Save".
- Hit "Sync Data" to start Reports Data Sync.
Note: "Sync Data" is required the first time after reports installation. Time taken to sync depends on amount of data in QMetry. Sync Progress and Status can be monitored as shown in the below screenshot. QMetry custom reports remain inaccessible during a sync in progress and are recommended to be run only during off-peak hours.
Users can start using QMetry Reports when the sync is completed. QMetry remains available during this time.
Podman and Podman-Compose Installation
Follow the steps mentioned below to install podman and podman-compose.
Note: Root user access is required to install Podman and Podman Compose.
Step 1. Copy the installation file (QMetryApp.zip/QMetryReport.zip/QMetryRDS.zip) you received from QMetry Support to your server. Navigate to the directory where this file is kept and execute the following commands.
Step 2. Execute the following commands.
- chmod +x podman_install.sh
- sudo sh podman_install.sh
It may take some time to install the podman and podman-compose utilities. Please wait until it gets completed.
If you are facing any issues during the installation process, kindly generate a support ticket on Support Portal for assistance.