Open

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.

AWS 3 Tier Architecture

Pre-requisites

For additional information on verifying pre-requisites refer this article. This installation requires MySQL v8.0.39 on AWS RDS and installs QMetry over Apache Tomcat 10.x and Open JDK 17.0.2 in a podman container.

1. QMetry Installation is supported only on Linux - RHEL8 and RHEL9. No other OS is certified for QMetry Installation. Rootless or non-root user installations are not supported on RHEL OS.

   • Note: Installations performed using a non-root user or a rootless installation method are not supported on RHEL OS.

2. Four Servers are required: 2 AWS RDS for QMetry and Reports Databases, QMetry Application, and QMetry Reporting. These servers should be able to communicate with each other on respective ports as mentioned in the table below. Security groups should be configured accordingly. Refer QMetry Deployment Document for the requirements. 

3. All the servers should have the support of these commands: unzip, wget, curl and vim.

4. Ensure internet access is enabled on all servers. Internet access is required to download and install podman and QMetry installation images.

5. Ensure Proxy Servers are not blocking downloads from the Internet.

6. Firewall and Selinux must be disabled on the server while installing QMetry and Reports.

7. QMetry Application and Report Servers should be able to communicate over 80/443 and Database Server 3306/DB Ports. Port 8080 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 report's server on port 3306.

8. Podman installation requires root user access. 

9. By default, podman is managing storage under “/var/lib/” directory on the host machine. Installer will ask you to set up a storage location for QMetry application files related data during the installation of QMetry. Hence, make sure that both the directories have required disk space available as per usage requirement of QMetry application.

10. Get the following files from QMetry Support: QMetryApp.zip, QMetryReport.zip and podman credentials required for installation. Post-installation, QMetry Application and Report tool both should be configured either on https or http.

11. 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.

12. Following Ports should be open for incoming connections on the respective servers:

13. 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.

    → 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. (Reference: GitHub - awslabs/amazon-ecr-credential-helper: Automatically gets credentials for Amazon ECR on docker push/docker pull)

Placing QMetry and Report Podman Images on the AWS ECR

Get Podman Image and place it on ECR. Perform these steps from 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.

Step 1. Execute the following command. When prompted, enter the Podman credentials provided with the installation package. 

Step 2. Pull the QMetry and Report podman images from podman repository. 

 Step 3. Tag QMetry and Report podman images with the ECR.     

Step 4. 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. 

If you have AWS CLI installed and configured on EC2, then you can use the following method to do authentication with ECR. 

Step 5. Push QMetry and Report podman images to ECR.    

Create and Configure 2 RDS for QMetry Application Database and QMetry Reports Database

Create 2 RDSs sharing a common parameter group as described below.

Step 1. Create DB parameter groups by following the below steps:

1. Go to AWS Management Console and open the Amazon RDS console.

2. In the navigation pane, select Parameter groups.

3. Click on the Create parameter group button.

4. Parameter group family: Select mysql8 as DB parameter group family.

5. Group name: Provide the name of the new DB parameter group.

6. Description: Provide a description for the new DB parameter group.

7. Click Create.

Similarly, create one more DB parameter group for Report RDS.

Step 2. Edit the DB parameter group you created above.

→ Edit the APP RDS parameter group:

• Select "Parameter Groups" option from the left panel and select the App parameter group that you have created in Step 1.

• Edit Parameters for the selected parameter group as follows.

→ Edit the Report RDS parameter group:

• Select "Parameter Groups" option from the left panel and select the Report parameter group that you have created in Step 1.

• Edit Parameters for the selected parameter group as follows.

Step 3. Create an RDS for QMetry APPLICATION DB and follow the steps below:

1. Create an RDS with MySQL database version 8.0.39

2. Provide RDS Name, Username and Password.

3. Select the Application DB Parameter Group that you have created in Step 2. 

• RDS > Databases > Actions > Start RDS Service.

• Connect to the QMetry Application’s RDS DB and execute the below query - which ensures whenever RDS restarts, mysql bin logs are not deleted - which is essential for dependable reports data sync.

  • call mysql.rds_set_configuration('binlog retention hours', 24);

Save the following details for QMetry Installation noted for QMetry App DB RDS.

• RDS username

• RDS password

• RDS Database Schema name

• RDS Endpoint

Step 4. Create an RDS for QMetry REPORTS DB and follow the steps below:

1. Create an RDS with MySQL database version 8.0.39

2. Provide RDS Name, Username and Password

3. Select the Reports DB Parameter Group that you have created in Step 2. 

4. Connect to the QMetry Report’s RDS DB and create a reports database named “qtmanalytics“ using the following query.

Save the following details for QMetry Reports Installation noted for QMetry Reports DB RDS.

• RDS username

• RDS password

• RDS Database Schema name

• RDS Endpoint

Installing QMetry Application

Recommendations

1. Create file system for QMetry using the AWS EFS service, which can be shared across all QMetry application nodes.

   • AWS EFS must be accessible to all EC2 servers of QMetry application. Ensure that required port #2049 in open for incoming connections in the security group to allow connections from AWS EC2.

2. While creating an EC2 instance for the application server, go to Configure Storage > File Systems > EFS and select File System created in the previous step.

   • Refer to the AWS Official Documentation for attaching EFS file system when creating an EC2 instance.

3. Also mount the EFS to an appropriate directory in the EC2 server. For example: If you choose a directory /opt/qmetryapp, then this directory should be specified as application directory at the time of QMetry installation

Step 1. Copy the QMetryApp.zip 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 command.

The next question during the installation process will be as follows.

Then you will be asked for credentials. Enter podman credentials shared as a part of the installation package.

Step 3. QMetry installation process will prompt for container repository url as follows. 

• Enter podman repository URL: <input_ecr_url> 

If AWS server has appropriate permission to download podman image from the ECR, then installation process will move forward with the next step. Otherwise, it will prompt for adding correct authentication details for the specified ecr url.

Step 4. 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.

Also, specify directory path for storing QMetry application's log files. This directory must not be shared across the multiple nodes of the QMetry application.

Step 5. Once the script finishes executing, it will prompt you to enter the following parameters:

The installation may take a while.

After successful installation of QMetry Application, you will see the message "QMetry Application Installation is complete".

Once the installation is complete, execute the following command:

Open

Step 6. Getting your QMetry License and Installing it.

1. For users evaluating QMetry

   • You should have received an evaluation license valid for 30 days along with the installation.

2. 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.

3. Once you receive license.key from QMetry Support, you can follow the Steps to Apply License file.

Step 7. Access the QMetry application using the following address.

http://<your IP Address OR Domain Name>

Default QMetry login credentials.

• Username: admin

• Password: <specified password in Step #4>

Step 8. After the above steps are completed, login to QMetry application with “admin“ user.

• On the top right corner, go to "Admin" Profile and edit the Profile.

• Update Email of Admin in the Email field.

• Enter the Base URL as your QMetry URL.

Open

Step 9. 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.

Installing QMetry Reports

Please follow below steps for installing QMetry Reports:

Step 1. Connect to Report Server and Download the installer file QMetryReport.zip

Upload the QMetryReport.zip to the /opt directory of the Report server and unzip it.

Step 2. Run the reports installer file.

You will be asked for credentials. Enter podman credentials shared as a part of installation package.

Step 3. Once the installation initiates, it will prompt to enter the following parameters:

Wait for the script file to finish executing.

Once the script finishes executing it will prompt to enter the following parameters.