QMetry BDD Installation Guide (Offline using Docker)

This guide walks you through the installation process of QMetry BDD.Setting up QMetry BDD with your on-premise QMetry Test Management (QTM) installation enables seamless integration of behavior-driven development practices into your testing workflow. With QMetry BDD, you can manage feature files, automate test executions, and streamline collaboration between business and technical teams.

QMetry BDD Installation Options

You can install QMetry BDD on the same server where the QTM Application is installed.

Pre-requisites for the Installation

Before installing QMetry BDD, ensure the following:

QMetry Application should be pre-installed. Refer to QMetry and Reports Installation on Linux - 2 Tier to install the QMetry Application. Follow Steps 1 to 7 (up to Enter Base URL) mentioned in the Install QMetry Application section. Please note that Step 7 is mandatory.
Active MQ server is configured with QTM Application.
All the servers must support the commands: unzip, curl, vim.
Internet access is enabled on all servers to install using docker.
Ensure Proxy servers are not blocking downloads.
Docker installation requires root user access.
Get the QMetry_Linux_Installer.zip file from QMetry Support.
The following should be installed on the server:
- CentOS, RHEL-7 and RHEL-8
- Docker Version 20.10.13
- Docker Compose Version v2.40.3
- Yum-tools
Make sure that the docker service has been configured on the server to start automatically on reboot of the server.
Required Ports
Installation
Ports that need to be enabled and should be available for use
ActiveMQ Server
8181 & 61616

Installation	Ports that need to be enabled and should be available for use
ActiveMQ Server	8181 & 61616

Download Docker Images of BDD Server

On an Internet-enabled machine, download the BDD Server Docker image by following these steps:

Run the following command. Next, it will ask for docker's credentials. Enter the credentials. Please contact QMetry Support, if you do not have the credentials.
```
docker login
```
Run the following commands to pull QMetry BDD docker image from the docker repository.
```
docker pull qmetry/qmetry:bdd_latest
```
The download has started. Wait until it finishes.
Run the following command to confirm the Docker image was downloaded successfully.
```
docker images
```
Run the following command to save the BDD Server Docker image as a .tar file. You can change the file path if needed."
```
docker save -o /opt/qtm/qmetrybdd.tar qmetry/qmetry:bdd_latest
```
Transfer the qmetrybdd.tar file to QMetry BDD Server.

Installing QMetry BDD Server

Get the QMetry_Linux_Installer.zip file from QMetry Support and copy it to the server for BDD installation.

Follow the steps mentioned below.

Copy the QMetry_Linux_Installer.zip installation file to your server and unzip it. Navigate to the directory where these files are saved.
```
unzip QMetry_Linux_Installer.zip
cd QMetry_Linux_Installer
```

Run the following commands.

sudo su
chmod +x install.sh
./install.sh

Select Installation Type: Online or Offline
Options
Allowed Values
Default Value
Recommended Value
Do you want to make an online installation (Y/N)?
Y, y, N, n
Y
N
Main Installation Menu: Type 6 to initiate QMetry BDD Installation

Options	Allowed Values	Default Value	Recommended Value
Do you want to make an online installation (Y/N)?	Y, y, N, n	Y	N

Enter configuration parameters as requested:

Prompt	Description	Example
Enter QMetry Database Host IP/DNS Name:	Host address where QMetry database is running. Note: In case of AWS installation enter the private IP of the AWS instance where the QTM Application's database is installed.	localhost
Enter QMetry Database Port (3306)	Database port number.	3306
Enter QMetry Database Schema (qmetry)	Schema name to be used by QMetry BDD.	qmetry
Enter QMetry Database UserName (root)	Database user with necessary rights.	root
Enter QMetry Database Password	Password for the above database user.	*****
Enter ActiveMQ Host URL	Host URL of ActiveMQ messaging service.	localhost:61616
Enter ActiveMQ UserName	Username for ActiveMQ authentication.	admin
Enter ActiveMQ Password:	Password for ActiveMQ user.	*****
Please enter full path of .tar file for docker image	For offline upgrade, mention the directory path of .tar file for docker image.	/opt/qmetrybdd.tar

Once the installation is complete, execute the following command.
```
docker ps
```
The following message will be displayed.
Enter the docker credentials provided by the support team.
The installation may take a while.
Once the installation is complete, execute the following command.
```
docker ps
```
Check for confirmation message - QMetry BDD Installation has been completed successfully.

Get support

For any installation issue, raise a ticket on the Support Portal.

In this section: