| Table of Contents |
|---|
In this guide, we'll run you through the installation of QMetry Test Management application and QMetry Reporting tool on a server without an internet connection. This document contains detailed steps regarding how to download QMetry application’s docker image and Report application’s docker image from the docker repository and how to move them to another machine for installation.
This installation installs QMetry over Apache Tomcat 9.x and Open JDK 17.0.2 in a docker container.
Pre-requisites
1. Following should be installed on the server
- CentOS, RHEL-7 and RHEL-8
- Docker Version 20.10.13
- Docker Compose Version v2.5.0
- Yum-tools
2. Make sure that the docker service has been configured on both QMetry Application and Report servers to start automatically on reboot of servers.
3. Two Linux Servers are required: One for QMetry application and the other for QMetry reporting.
4. Refer QMetry Deployment Document for the hardware requirements.
...
7. Application and Report servers should be in the same network. Report Server should be able to communicate with Application Server over 80/443 and Database Server 3306/DB Port. Ports 8080 and 33061 should be enabled/open on Reports Server to allow connections from the QMetry application server.
8. Docker installation requires root user access. To install using a non-root user, follow the steps specified here before starting the install on both QMetry Application and Report servers.
9. By default, docker is managing storage under “/var/lib/” directory on the host machine. It will also ask for storage location of QMetry application’s file 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 these files from QMetry Support: QMetryApp.zip and QMetryReport.zip for installation.
11. Post installation, QMetry application and QMetry Report both should be configured either on https or http.
12. 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.
13. The following Ports should be open:
Installation | Ports that need to be enabled and should be available for use |
|---|---|
| QMetry Application | 80/443 & 3306 |
| QMetry Reporting Tool | 80/443, 8080 & 33061 |
Download Docker Images of QMetry and Report
...
Step 1. Execute the following command. Next, it will ask for docker's credentials. Enter the required credentials. Please contact QMetry Support, if you do not have the credentials.
- docker login
After entering docker credentials, it will show the success message as shown below.
...
The next question during the installation process will be as follows.
Options | Allowed Values | Default Value | Recommended Value |
|---|---|---|---|
| Do you want to make an online installation (Y/N)? | Y, y, N, n | Y | N |
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.
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.
...
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.
...
- For users evaluating QMetry:
- You should have received an evaluation license valid for 30 days along with the installation.
- Follow the Steps to Apply License file.
- For users requiring 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 7. Access QMetry application using the following address.
...
Follow the steps mentioned below.
Step 1. Download and place QMetryReport.zip file on Report server in the same directory of qmetryreport.tar and qmetryreportdb.tar files.
Step 2. On Report server, navigate to the directory where .tar file has been placed and execute the following command.
- sudo docker load -i qmetryreportdb.tar
- sudo docker load -i qmetryreport.tar
Execute the following command to check whether the docker images have been restored correctly or not.
- sudo docker images
Step 3. Execute following command to unzip the QMetryReport.zip file.
- unzip QMetryReport.zip
- cd QMetryReport
- sudo su
- sh +x qmetry.sh
The next question during the installation process will be as follows.
Options | Allowed Values | Default Value | Recommended Value |
|---|---|---|---|
| Do you want to make an online installation (Y/N)? | Y, y, N, n | Y | N |
Step 4. Users are required to enter value of required configuration 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 |
...
Options | Details | Example |
|---|---|---|
Enter Mysql Database Host IP / DNS Name (Qmetry) | Enter Database Host Public 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 Public IP/DNS of QMetry Report. If it is unchanged, enter 'qmetry-reports-db' as Database Host. | qmetry-reports-db |
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 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".
Wait for about 2 minutes - docker ps command should give output as shown below.
...