QMetry Online Upgrade Document for Linux (from below v8.16.0.1 to the latest version)

1 Pre-requisites
2 Steps to Upgrade Document for Linux
3 Changes Regarding SSL (https)

If you are upgrading to QTM v8.18.1 and the existing QMetry application’s version is below v8.16.0.1, update the Single Sign On (SSO) login URL. Go to Changes in SSO URL in QMetry Onpremise for v8.18.1 and refer to the corresponding Identity Provider page to know the URL changes.

In this guide, we will run you through upgrading to QMetry Test Management v8.18.1 from any previous version. These steps should be followed on your QMetry app server hosted on the Linux machine.

Pre-requisites

Important Prerequisites to check before the upgrade:

MySQL version of QMetry Reports and QMetry Application should be v8.0.40.
Ensure internet connectivity is enabled on the server for this upgrade.

Steps to Upgrade Document for Linux

Step 1: IMPORTANT: Backup existing QMetry Database

Take the backup of your existing “qmetry” database. You can replace the username, password, and location of the backup file (currently default /opt).

Syntax: docker exec qmetryapp_db sh -c 'exec mysqldump -uroot -p<password> --triggers --routines --hex-blob --single-transaction --lock-tables --no-create-db qmetry' > /opt/qmetry_backup_<date>.sql
For example: docker exec qmetryapp_db sh -c 'exec mysqldump -uroot -pqmetry --triggers --routines --hex-blob --single-transaction --lock-tables --no-create-db qmetry' > /opt/qmetry_backup_2023-01-01.sql

Verify that your database has been backed up properly and is available for later use in case of any emergency.

Step 2: Download Required Files

You can generate a request on the QMetry Support Portal, to get the latest version of QMetry Upgrade Installer.
Download the QMetryApp.zip to your QMetry Application Server on host machine once you receive it.

Step 3: Run the QMetry Upgrade

1. Check the running containers using the following command. The dockers must be running to ensure a successful upgrade.

docker ps

If the dockers are not running, start them using the below commands (replace container names according to the application container name seen in the command above)

docker start qmetryapp_db
docker start qmetry_app_1

2. Go to the directory where the QMetryApp.zip file is downloaded.

3. Unzip the file QMetryApp.zip on the host machine.

unzip QMetryApp.zip

4. Go to QMetry directory:

cd QMetryApp

5. Give permission to file through the following command.

chmod +x upgrade.sh
chmod +x qmetry.sh

6. Execute the commands as per the existing QMetry version.
If the existing QMetry application version is below 8.16.0.1, execute the following command.

./upgrade.sh

The utility will confirm if you want to upgrade.

Options	Allowed Values	Default Value	Description
Do you want to make an online installation (Y/N)?	Y,y,N,n	Y	Enter “Y” to begin the online upgrade. Else, enter “N”.

Wait for the process to complete.

Step 4: Restart QMetry and MySQL Docker Container

Check the running containers using the following command:

docker ps

Restart both docker containers using the below commands:

docker stop qmetry_app_1 qmetryapp_db
docker start qmetryapp_db
docker start qmetry_app_1

Step 5: Installing / Upgrading the Jira add-on for the Integration of QMetry and Jira.

Note: It is important to have the correct version of the Jira add-on installed in Jira based on your upgraded and current QMetry version. Refer to the below table for the right version of "QMetry Jira Integration".

QMetry Version	Jira-addon version required
8.18.1 & above	2.2.9, 2.3.0_jira9 (Jira Version 9x), 2.3.0 (Jira Version 10x)
8.17.1	2.2.8
8.17.0	2.2.7

Upgrade your Jira add-on as per the above compatibility matrix. In case you have not installed the QMetry Jira Integration app for integration, follow the Steps to Install and Configure the QMetry Jira Integration app, if it is not installed.

If you are upgrading from QMetry version 8.8.0 or lower, then Jira force sync is required. Follow the Jira Force Sync document.

Changes Regarding SSL (https)

In case, you have configured SSL (https) in tomcat within the container then you need to setup SSL (https) again in new docker container after upgradation to the latest QMetry version. Refer to the article SSL Certificate Configuration for Tomcat in Docker.

If you are facing any issues during the upgrade process, kindly generate a support ticket on the Support Portal for assistance.

Note: If you are upgrading the QTM app to version 8.18.1, it is essential to update the Automation API to the latest version. Refer to Install/Upgrade Automation API Feature for Online Installations.