QMetry and Reports Installation - 3 Tier
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 | MySQL DB |
| Server 3 | QMetry Reports |
Pre-requisites
For additional information on verifying pre-requisites refer this article. This installation installs QMetry over Apache Tomcat 9.x, MySQL v5.7.29 and Open JDK 11 in a docker container.
- QMetry Installation is supported only on Linux - Cent OS 7 and 8, and RHEL 7 and 8. No other OS is certified for QMetry Installation.
- 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, wget, 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. QMetry App server should be able to communicate with the reports server on port 33061.
- 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/qmetry_mysql_data/_data
- Data of QMetry attachments added is saved under : /var/lib/docker/volumes/qmetry_attachment/_data
- Get the following files from QMetry Support : QMetryApp.zip, QMetryRDS.zip, Spark_Report_Install.zip and docker 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, 8000, 33061 |
Setting up QMetry DB Server
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
- unzip QMetryRDS.zip
- sh -x Mysql_docker_install.sh
You will be asked for credentials. Enter docker credentials shared as a part of installation package.
Once the script finishes executing, check if MySQL docker is available with name : qmetry_rds_1 - when you run the docker ps command.
.png?version=1&modificationDate=1586753867519&cacheVersion=1&api=v2&width=900&height=39)
Note : With installation, MySQL 5.7.29 will be installed on port 3306. Below are the details
- Username : root
- Password : qmetry
- Schema : qmetry
Installing QMetry Application
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
- unzip QMetryApp.zip
- cd QMetry
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.
- chmod +x QMetry.sh
- 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
.png?version=1&modificationDate=1586753867379&cacheVersion=1&api=v2&width=900&height=38)
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 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 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 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 QMetry application using the following address.
http://<your IP Address OR Domain Name>
Default QMetry login credentials.
- Username: admin
- Password: qmetry@123
Note : This installation installs QMetry over Apache Tomcat 9.x, and Open JDK 11 in a docker 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 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.
Installing QMetry Reporting
If you have purchased Advanced Reporting then you will need a separate server for QMetry Reporting.
This step we'll run you through installing QMetry Test Management Reports in your environment.
Hardware Configurations Recommended
Supported OS : Linux - Cent OS 7 and 8, RHEL 7 and 8
Server Configurations | Small Teams < 50 Users | Medium Teams < 500 Users | Large Teams 500+ Users | |||
| Stand Alone Server | ||||||
| Min | Recommended | Min | Recommended | Min | Recommended |
CPU | 4 Cores | 4 Core | 8 Core | 16 Core | 16 Core | 24 - 32 Core |
Memory | 8 GB | 16 GB | 16 GB | 24 GB | 32 GB | 32 - 64 GB |
HDD (Free Space) | 100 GB | 250 GB | 50 GB | 100 GB | 50 GB | 500 GB |
Steps to Install QMetry Reports
Step 1 - Connect to Report Server and Download the file.
Upload the Spark_Report_Install.zip to the /opt directory of the Report server and unzip it
- sudo su -
- cd /opt
- unzip Spark_Report_Install.zip
- cd Spark_Report_Install/
Step 2 - Run the reports installer file
- chmod +x spark-install.sh
- sh spark-install.sh
- The install script prompts the following options
| Options | Details | Example |
|---|---|---|
| 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 | 6 |
| Memory to allocate in GB(s) | Allocate 3/4th of total memory on server. For example for 24GB, enter 18 To check total memory, run the command : free -h | 18 |
Wait for the script file to finish executing.
Step 3 - Add reports configuration to the apps file by executing it
- cd /var/lib/docker/volumes/spark_report_spark-apps/_data
- sh ConfigureSyncApp.sh
Once the script finishes executing it will prompt to enter the following parameters
| Options | Details | Example |
|---|---|---|
| qmetry-host | QMetry DB Host Public IP/DNS | 10.10.11.100 |
| qmetry-port | QMetry App MySQL DB Port. Enter 3306, unless QMetry DB port is different | 3306 |
| qmetry-schema | QMetry App DB schema name. Enter : qmetry | qmetry |
| qmetry-username | QMetry App DB username. Enter : root | root |
| qmetry-password | QMetry App DB password. If it is unchanged from default, enter : qmetry | qmetry |
| Reports-host | Enter the static docker IP : 10.5.0.7 as the IP address of QMetry Reports server | 10.5.0.7 |
| Reports-port | Enter the port where reports DB is running. Enter : 3306 | 3306 |
| Reports-schema | Enter the database schema name of QMetry Reports DB - | qtmanalytics |
| Reports-username | Enter username of QMetry Reports DB | root |
| Reports-password | Enter password of QMetry Reports DB - qmetryreports@!Nf0# | qmetryreports@!Nf0# |
| server-port | Reports Sync Job runs from this port - recommended : 8000 | 8000 |
| forceSync | Enter y to sync all the QMetry data to Reports DB with the current script. Always enter y at the time of fresh reports install | Type : y |
| Enter Memory to allocate in GB(s) to Spark | Entered memory would be used by the sync job while running a full sync of data. Enter 3/4th of total memory available on server. For example, if memory on server is 24 GB, enter 18 | 18 |
Note: In cases when you need to force sync to re-sync any missing data, just repeat step 3, and skip qll 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 docker ps should return the following :
.png?version=1&modificationDate=1586753867247&cacheVersion=1&api=v2&width=900&height=84)
Step 4 - Restart Reports Services
- docker restart qmetry-reports qmetry-reports-db
Step 5 - Login to QMetry with 'admin' user login, and configure the reports server URL in the configuration menu
Go to QMetry > Customization > Insight Configuration
- Enter Host : Reports Server Host Public IP/DNS
- Enter Port : 33061
- Enter Username : root
- Enter Password : qmetryreports@!Nf0#
Enter Database Name : qtmanalytics
Cick Test to ensure successful connection and then hit "Test and Save"
Your QMetry and Reports Installation is complete.
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.