Open

Note: If you are upgrading to QTM v8.16.0.1, you need to update the Single Sign On (SSO) login URL. Go to https://qmetrysupport.atlassian.net/wiki/spaces/QTMSv816/pages/3571024060 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.16.0.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 8.0.33.

• Ensure internet connectivity is enabled on the server for this upgrade.

Step 1: IMPORTANT: Backup your 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 qmetry_rds_1 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 qmetry_rds_1 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 qmetry_rds_1

  • 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 upgrade_81601.sh file through the following command.

• chmod +x upgrade_81601.sh

6. Execute the commands as per the existing QMetry version.
Note: If the existing QMetry version is below 8.9.0.3, then make sure to validate the name of an existing container and license volume in upgrade_81601.sh file before running it.

Steps to validate the name of an existing container and license volume:

• Check docker volumes name using the below command.

  • docker volume ls

• Docker volume name should be qmetry_license.

• Check docker container name using the below command.

  • docker ps

• Docker container name should be qmetry_app_1. 

• If any of this name is not same as above, then update upgrade_81601.sh file for changed value with the respective names using following steps.

Open the file – upgrade_81601.sh in edit mode.

• vi upgrade_81601.sh

• Press i to change the file mode to insert.

• Update the variable value according to the existing docker volume and docker container name.

  • exist_license_volume → Value from docker volume ls for license 

  • exist_qmetry_container → Value from docker ps for qmetry

• Press Esc, and then type :wq to save the changes. 

7. Execute this command

• sh upgrade_81601.sh 

8. Utility will confirm if you want to upgrade.

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".

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.

Important Note:

• 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 a 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.16.0.1, it is essential to update the Automation API to the latest version. Refer to https://qmetrysupport.atlassian.net/wiki/spaces/QTMSv816/pages/3541044327.