QMetry and Reports Installation on AWS (using RDS & ECR) for RHEL8, RHEL9 and RHEL10
In this guide, we'll run you through installing QMetry Database on AWS RDS, QMetry Test Management application, and QMetry Reporting Tool in a 3 Tier Architecture on AWS.
This installation requires MySQL v8.4.8 on AWS RDS and installs QMetry over Apache Tomcat 11.0.5 and Open JDK 17.0.2 in a podman container.
AWS 3 Tier Architecture
3 Tiers | Installations |
|---|---|
Server 1 | QMetry Application |
Server 2 | QMetry Reports |
AWS RDS 1 | QMetry Database |
AWS RDS 2 | QMetry Reports Database |
Pre-requisites
Confirm every item in the Pre-requisites for QMetry Application and Report Server Installation document. For hardware requirements, refer QMetry Deployment Document. After that confirm the following:
Prerequisite | What to confirm |
|---|---|
Operating System | Linux - RHEL8, RHEL9 and RHEL10 Rootless or non-root user installations are not supported on RHEL OS. |
Required commands | unzip, wget, curl, and vim commands are supported. |
Internet access | Internet access is required to download and install Podman and QMetry installation images. |
Firewall and SELinux | Both are disabled on every server during installation. |
Proxy Servers | No proxy blocks downloads from the internet. |
Server communication | The application and report servers can reach each other on the required ports. |
Open ports | Ports 80, 443, 8081 and 3306 are free on the relevant servers. |
Root access | Podman installation requires root user access. |
Disk space | The Podman and data directories have enough free space. |
Installation files | Get the |
In addition to this, ensure the following:
By default, podman is managing storage under “/var/lib/” directory on the host machine. Make sure that both the directories have required disk space available as per usage requirement of QMetry application.
QMetry Application's Server and QMetry Report's Server must have appropriate IAM roles assigned to communicate with various other AWS services like AWS ECR, AWS RDS, etc.
Required Ports
The following ports should be open:
Installation | Ports that need to be enabled and should be available for use |
|---|---|
AWS RDS - QMetry Application Database and QMetry Reports Databases | 3306 for both RDS |
QMetry Application | 80/443 |
QMetry Report | 80/443, 8081 & 3306 |
AWS EFS | 2049 |
AWS ElastiCache (if enabling the optional Redis Cache Cluster) | 6379 |
QMetry Application and Report Servers should be able to communicate over 80/443 and Database Server 3306/DB Ports.
Port 8081 should be enabled/open on Reports Server.
The ports 80/443 and 3306 on the respective servers should be free.
QMetry App server should be able to communicate with the report's server on port 3306.
Configure AWS EC2 to authenticate with AWS ECR Service
Install and configure AWS Credential Helper. If you want to use AWS IAM Role based authentication mechanism for ECR authentication from AWS EC2, then follow this step. Else, skip this step and make sure that you have done authentication with AWS ECR from QMetry and Report EC2 server before moving to the next step.
Refer to Github Credential Helper for more details.
Placing QMetry and Report Podman Images on the AWS ECR
Get Podman Image and place it on ECR. Perform these steps on the machine from which Docker Hub Container Image Library | App Containerization is accessible. It is required to have podman tool installed on this machine. Also, make sure that you have credentials for the ECR. In this step, we will download QMetry and Report podman image from podman repository and push it to the ECR repository.
Follow the steps mentioned below.
Log in to Podman. Eenter the Podman credentials provided with the installation package.
podman login
Pull the QMetry and Report podman images from podman repository.
podman pull qmetry/qmetry:latest podman pull qmetry/qmetry:reports_latest
Tag QMetry and Report podman images with ECR.
podman tag qmetry/qmetry:latest <ECR_Repo_Url>/qmetryapp:latest podman tag qmetry/qmetry:reports_latest <ECR_Repo_Url>/qmetryreport:latest
Log in with AWS ECR.
If you have set up and configured AWS Credentials Helper utility on EC2 servers, then skip this step and move to the next step.
Else, login with AWS ECR. If you have ECR credentials, then log in with ECR using it.
podman login <ECR_Repo_Url>
If you have AWS CLI installed and configured on EC2, then you can use the following method to do authentication with ECR.
aws ecr get-login-password --region <regionID> | podman login --username AWS --password-stdin <ECR_Repo_Url>
Push QMetry and Report podman images to ECR.
podman push <ECR_Repo_Url>/qmetryapp:latest podman push <ECR_Repo_Url>/qmetryreport:latest
Create and Configure 2 RDS Instances
Create two RDS instances that share a common parameter-group family, one for the Application database and one for the Reports database.
Step 1. Create DB parameter groups
To create a DB parameter group, do the following:
Go to AWS Management Console and open the Amazon RDS console.
In the navigation pane, select Parameter groups.
Select Create parameter group.
Parameter group family: Select mysql8 as DB parameter group family.
Group name: Provide the name of the new DB parameter group.
Description: Provide a description for the new DB parameter group.
Click Create.
Repeat these steps to create a second parameter group for the Reports RDS instance.
Step 2. Edit the parameter groups
To edit the parameter groups, do the following:
Open the parameter group that you created for the application database.
Set the following parameters, and then save your changes.
Parameter
Value
binlog_format
ROW
character_set_client
utf8mb4
character-set-client-handshake
0
character_set_server
utf8mb4
collation_server
utf8mb4_unicode_ci
group_concat_max_len
500000000
innodb_autoinc_lock_mode
2
innodb_thread_concurrency
10
log_bin_trust_function_creators
1
lower_case_table_names
1
max_allowed_packet
536870912
sql_mode
NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO
thread_cache_size
200
innodb_log_buffer_size
536870912
innodb_log_file_size
1073741824
Open the parameter group that you created for the Reports database.
Set the following parameters, and then save your changes.
Parameter
Value
character-set-client-handshake
0
group_concat_max_len
500000000
innodb_autoinc_lock_mode
2
innodb_strict_mode
0
lower_case_table_names
1
max_allowed_packet
536870912
thread_cache_size
200
Step 3. Create the Application Database RDS
To create application database RDS, perform the following steps:
Create an RDS with MySQL database version 8.4.8
Enter the RDS instance name, user name, and password.
Select the application DB parameter group that you configured in Step 2.
Start the service: RDS → Databases → Actions → Start.
Connect to the application RDS instance and run the following so MySQL bin logs survive restarts (required for dependable report sync):
call mysql.rds_set_configuration('binlog retention hours', 24);
Note
Save the Application RDS username, password, schema name, and endpoint. You will need them during installation.
Step 4. Create the Reports Database RDS
To create Reports Database RDS, perform the following steps:
Create an RDS with MySQL database version 8.4.8
Enter the RDS instance name, user name, and password.
Select the Reports DB parameter group that you configured in Step 2.
Connect to the Reports RDS and create the analytics schema:
CREATE SCHEMA `qtmanalytics` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
Note
Save the Reports RDS username, password, schema name, and endpoint.
Install QMetry Application
To install QMetry Application, perform the following steps:
Note
Recommended: Back up the application data directory on a regular schedule. Periodic backups help prevent data loss if a disaster occurs.
Copy
QMetry_Linux_Installer.zipinstallation file received from QMetry Support to your server. Go to the directory where this file is kept and unzip the file.unzip QMetry_Linux_Installer.zip
Run the installer.
cd QMetry_Linux_Installer sudo su chmod +x install.sh ./install.sh
Enter your response for the online prompt.
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, type 2 to install the QMetry application.
Enter a directory path on the host machine to store QMetry data such as attachments, licenses, imports, and exports. You can specify any valid path, and the installer creates the directory automatically if it does not exist.
Options
Description
Example
Please enter QMetry application directory
Enter the EFS file system directory mounted for QMetry installation from the pre-requisites section above step 1.
/opt/qmetryapp
Configure the parameters.
Options
Details
Default Value
Example
Enter QMetry Database Hostname
Enter QMetryDatabase Host as DNS/IP Address
<RDS DB Endpoint>
Enter RDS DB Endpoint
Enter QMetryDatabase Port
Enter QMetryDatabase Port. If it is unchanged, use "3306" as the Database port.
3306
3306
Enter QMetryDatabase Schema
QMetry Application Database schema name.
qmetry
qmetry
Enter QMetryDatabase Username
QMetry Application Database root user name
-
dbadmin
Enter QMetry Database Password (root user)
Enter QMetryApplication Database Password for the root user.
-
QMetry@123
Enter QMetry User (admin) Email (admin user)
Enter QMetry user email address for Admin.
-
Enter QMetry User (admin) Password
Enter QMetry user password for Admin.
-
Admin@123
Enter Min. Heap Memory for the webserver
Enter Heap Memory in GB(s)
2
2
Enter Max. Heap Memory for the webserver
Enter Heap Memory in GB(s)
4
4
Enter QMetry Database Connection Pool Size
Enter Pool Size in number format
100
100
Verify the docker.
docker ps
Get QMetry License and install it.
Evaluation: Use the evaluation license, valid for 30 days, that you received with the installation.
Commercial: You must generate a license using the server MAC address and domain name.
Get MAC address
ifconfig
Send the domain name and MAC address to QMetry Support at [email protected] to request your license.
Once you receive license.key from QMetry Support, you can follow the Steps to Apply License File.
Open the QMetry application in a browser at the following address, where you substitute your own value. http://<your IP address OR domain name>. Log in with the Default QMetry credentials.
Username: admin
Password: <user specified password in Step # 4 >
MySQL database is installed on port 3306 with the following details.
Username: root
Password: <user specified password in Step # 4 >
Log in to the QMetry application and update the administrator profile.
Go to Admin Profile and click Edit.
Update the administrator email address in the Email field.
In the Base URL field, enter your QMetry URL.
Select Update.
Configure Additional Tomcat settings.QMetry installs with a default configuration for minimum and maximum heap memory. You can adjust these settings to match your hardware configuration. For more information, refer to Additional Configuration.
Install QMetry Reports
Note
If you have purchased Advanced Reporting, then you will need a separate server for installing QMetry Reports.
To install QMetry Reports on the second server, perform the following steps:
Connect to the report server. Upload the
QMetry_RHEL_Installer_ECR.zipto the /opt directory of the Report server and extract it with the following commands.sudo su - cd /opt unzip QMetry_RHEL_Installer_ECR.zip cd QMetry_RHEL_Installer_ECR/
Run the reports installer.
chmod +x install.sh ./install.sh
Enter your response to the online prompt.
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 podman credentials that were shared as part of the installation package.
On the main installation menu, type 3 to install QMetry reports.
Configure the report parameters.
Options
Details
Default Value
Example
Enter Number of CPUs 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 to finish and enter the following details:
Options
Details
Example
Enter Mysql Database Host IP / DNS Name (Qmetry)
Enter Database Host Public IP/DNS of QMetry application.
Specify QMetry App RDS DB Endpoint
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 Public IP/DNS of QMetry Report.
Specify QMetry Reports RDS DB Endpoint
Enter Mysql Database Port (Reports)
Enter Database Port of QMetry Report Database. If it is unchanged, enter "3306" as Database Port.
3306
Enter Mysql Database Schema (Reports)
Enter Database schema name as “qtmanalytics“ for 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 - 8081.
8081
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 6, and skip all parameter details (by hitting enter) and just enter y when prompted for a force sync.
Verify the podman.
podman ps
Restart the report services.
systemctl restart qmetry-reports
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: Reports Server Host Public IP/DNS.
Port: 3306
Username: root
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 the first time after you install QMetry reports installation. 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.
Users can start using QMetry Reports when the sync is completed. QMetry remains available during this time.
Enabling Redis Caching Cluster (optional)
QMetry provides a capability for improving the overall performance and scalability even more by setting up Redis Caching Cluster. This step is optional. Follow the below steps to configure Redis Cache.
Create a Redis cluster using AWS ElastiCache service for the Redis v7.0.7
AWS ElastiCache Redis Cluster should be accessible to all the EC2 servers of QMetry application for caching related communication and configuration.
Ensure port #6379 is opened for incoming connections in the security group to allow connections from AWS EC2.
Port #6379 should be free and not in use by other applications.
Configure Redis connection details in QMetry.
Login to QMetry Application using “admin“ account, and go to the top right corner admin > Profile section. Edit the Profile.
Enter the Redis URL and Test. In case, the test fails, check and ensure connectivity between ElastiCache Redis Cluster and AWS EC2.
Upon successful Test, update the details.
Install Automation API Features
Installing the Automation API with your on-premises QMetry installations will enable several automation API related features including faster automation result file imports into QMetry. If you plan to use Automation APIs to import test results into QMetry, refer toInstallation for Automation API.
Get Support
If you encounter any issues during installation, create a ticket on the SupportPortal.