v8.5.6 and Reports Installation Guide for 3-Tier Architecture
In this guide, we'll run you through installing QMetry Database, QMetry Test Management application and QMetry Reporting Tool in a 3 Tier Architecture.
Pre-requisites
For additional information on verifying pre-requisites refer this article. This installation installs QMetry over Apache Tomcat 9.x and Open JDK 11 in a docker container.
- 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 support of these commands: unzip, curl and vim.
- Internet access should be enabled on all 3 servers to install using docker.
- Firewall and selinux must be disabled on the server while installing QMetry and Reports.
- 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 and Database Server 3306/DB Ports.
- The ports 80/443 and 3306 on the respective servers should be free and should not be in use by other applications.
- 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 and Report servers.
- Docker is installed under /var/lib/ directory. We recommend allocating enough space here to ensure QMetry has enough space to save your data.
- Data of QMetry database is saved under : /var/lib/docker/volumes/qmetry85_mysql_data/_data
- Data of QMetry attachments added is saved under : /var/lib/docker/volumes/qmetry85_qmetry_attachment/_data
- Get the following files from QMetry Support : MysqlInstall.zip, QMetryApp.zip, QMetryReport.zip and 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 |
| QMetry Reporting Tool | 80/443, 3000 & 56982 |
Setting up QMetry DB Server
Step 1. Copy the MysqlInstall.zip file received from QMetry Support to your server. Navigate to the directory where this file is kept and execute the following commands.
- sudo su
- unzip MysqlInstall.zip
- sh -x Mysql_docker_install.sh
You will be asked for credentials. Enter docker credentials shared as a part of installation package.
Installing QMetry Application
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.
- sudo su
- unzip QMetryApp.zip
- cd QMetry85
Step 2. Modify docker-compose.yml file with the MySQL DB details:
- DB_HOST = Specify Database Server IP Address.
- DB_Schema = Specify Database schema for QMetry Application to use.
- DB_POrt = Specify Port of Database Server.
- DB_User = Specify Database Username.
- DB_Pass = SPecify Database Password.
Execute the below commands:
- vim docker-compose.yml, press "i" to go to insert mode and update these parameters.
- Once updated, press Esc followed by : + wq to save the changes.
Step 3. Execute the following command.
- sh -x QMetry.sh
Step 4. Enable Service for Docker Engine.
- systemctl enable docker
You will be asked for credentials. Enter docker credentials shared as a part of installation package.
The installation may take a while. Once the installation is complete, execute the following command.
- docker ps
The following message will be displayed.
Step 4. Getting your QMetry License and Installing it.
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 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.
Step 5. Access QMetry application using the following details:
- URL: http://<IP Address>:<Port No.>
- Default QMetry login credentials.
- Username: admin
- Password: qmetry@123
- 30 days license with 5 users is included by default.
Step 6. 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.
Step 7. 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 Reporting Tool
Step 1. Copy the QMetryReport.zip installation file received from QMetry Support to your server. Navigate to the directory where this file is kept and execute the following commands.
- unzip QMetryReport.zip
- cd QMetryReport
Step 2. Execute the following commands.
- sudo su
- sh -x qmetryreport85-install.sh
You will be asked for credentials. Enter docker credentials provide by support team.
The installation may take a while. Once the installation is complete, execute the following command.
- docker ps
The following message will be displayed.
Execute the following commands.
- docker exec -it qmetryreport85_report_1 /bin/bash
- chmod 755 change_setting_lgx_file.sh
- sh change_setting_lgx_file.sh
You will be asked for the below details
| Options | Type | Comments / example |
|---|---|---|
| Enter Mysql Database Host IP / DNS Name | Mandatory | QMetry DB Host Public IP/DNS, example: 10.10.11.100 |
| Enter Mysql Database Port | Mandatory | QMetry DB Port, example: 3306 |
| Enter Mysql Database Schema | Mandatory | Name of existing QMetry Application DB, example: qmetry |
| Enter Mysql Database UserName | Mandatory | QMetry DB Username, example: root |
| Enter Mysql Database Password | Mandatory | QMetry DB Password |
| Enter SMTP HostName | Optional | SMTP Server Host IP/DNS, for sending report emails |
| Enter SMTP From Email | Optional | From email address that appears while emails are received |
| Enter SMTP Authentication Password | Optional | SMTP Server Authentication Password (hit enter if no password is required) |
| Enter SMTP Port | Optional | SMTP Server Port, example: 587 |
| Enter Qmetry Application Service URL with Port No. (http://demo.qmetry.com) | Mandatory | Complete QMetry URL, example : http://demo.qmetry.com |
Do you have configured Load Balancer for Report Server? Y/N | Mandatory | Y/N |
Do you have https (SSL) configured for Report Server (Y/N) ? In case of having Load Balancer, consider SSL of Load Balancer. | Mandatory | Y/N |
Mention DNS/IP Address (accessible in network) of Report Server. In case of Load Balancer, specify DNS of Load Balancer. | Mandatory | Report Server's DNS/IP Address, example:<ReportServerIP/DNS> |
Enter IP Address of QMetry & Report Server (Add Multi IP Address separated by comma. If you have Load Balancer, then enter subnet IP range). | Mandatory | QMetry App and Report Server IP Addresses, comma separated without space. If you have Load Balancer or range of IP, then you need to allow range. For example, to allow all addresses in the range of 172.16.*.*, specify: 172.16.0.0 0.0.255.255 |
- exit
Step 3. Verify installation of QMetry Reporting tool through the following URL.
- http://<IP Address>:3000/datahub
You should see the following login page. (There is no need for login).
Step 4. After the above steps are completed, log into QMetry application.
- Go to "Admin" Profile and Edit the Profile.
- Update QMetry Base URL and Report Server URL
- The ports must be mentioned in the URL if QMetry URL OR Report URLs are running on ports other than 80/443 (example 8080).
Installing Redis Caching Server
With the release of v8.5.2, QMetry is providing capability of installing Redis server. Overall performance and scalability can be improved using Redis caching. To install the Redis Server, refer to Installing Redis Caching Server.
If you are facing any issues during the installation process, write us at qtmprofessional@qmetrysupport.atlassian.net. This will automatically open a ticket with our support team and help you to follow the progress.