/
QMetry Online and Offline Upgrade Guide for Linux

QMetry Online and Offline Upgrade Guide for Linux

 

image-20240729-123126.png

 

 

Notes

 

Overview

This guide is intended for customers running QMetry containers on Linux and outlines the steps to upgrade from an older version of QMetry to the latest release. In addition to upgrading QMetry, it also includes the upgrade of Apache Tomcat to version 11.0.5.

The guide provides detailed instructions for backing up the QMetry database, upgrading the application, updating containers, and configuring SSL and Jira integration.

System Requirements and Pre-requisites

Before upgrading, ensure the following:

  • MySQL version for both QMetry Reports and QMetry Application is 8.0.40.

  • Internet connection is enabled on the server.

Perform the following steps:

Step 1. Download Docker images of QMetry products.

Step 2. Transfer and restore the downloaded Docker images.

 

Once this is done, ensure the following:

  • MySQL version of QMetry Reports and QMetry Application is 8.0.40.

 

QMetry Online and Offline Upgrade Process for Linux

To upgrade QMetry to the latest version, perform the following steps:

Step 1: Backup the Existing QMetry Database

To backup your existing QMetry database, perform the following steps:

  1. Take a backup of the "qmetry" database. The backup is saved in /opt by default.

  2. Run the following command to replace the username, password, and backup file location.

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

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

  1. Verify that the database is backed up and is available.

 

Step 2: Download Required Files

Download the required files by following these steps:

  • Get the latest version of QMetry Upgrade Installer from the QMetry Support Portal.

  • Download LinuxQMetryAppTomcatUpgrade.zip to the QMetry Application Server on the host machine.

 

Step 3: Run the QMetry Upgrade

To run QMetry Upgrade, perform the following steps:

  1. To list the running containers, run the following command:

docker ps

 

If Docker is not running, run the following command:

docker start qmetryapp_db docker start qmetry_app_1

 

Make sure to replace the container names with the appropriate application names as specified in the previous command.

  1. Go to the directory where the LinuxQMetryAppTomcatUpgrade.zip file is located and unzip the file LinuxQMetryAppTomcatUpgrade.zip on the host machine. 

unzip LinuxQMetryAppTomcatUpgrade.zip

  1. Go to the extracted QMetry directory

cd LinuxQMetryAppTomcatUpgrade

  1. Run the following command to grant execution permissions to the upgrade script.

chmod +x upgrade.sh

 

Validate the name of your existing container and license volume in the upgrade.sh file before running it.

To validate the name of your existing container and license volume, perform the following steps:

  1. Run the following command to check the Docker volumes' names

docker volume ls

Docker volume name should be qmetry_license.

  1. Run the following command to check the Docker containers' names

docker ps

Docker container name should be qmetry_app_1. 

  1. If the names differ, update the upgrade.sh file with the correct values with these steps:

    • Open upgrade.sh in edit mode.

    • Run the following command:

    • vi upgrade.sh

    • Update the file with the correct volume and container names.

    • Press i to change the file mode to insert.

    • Update the variables according to the existing volume and 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. 

5. Run the upgrade script:

sh upgrade.sh 

The process may take some time to complete. Kindly be patient and allow it to finish properly.

 

Step 4: Enter the Required User Inputs

The upgrade utility will prompt you to confirm whether you want to proceed with the upgrade.

 

Mode of Installation

Prompt

Values

Default

Details

Mode of Installation

Prompt

Values

Default

Details

Linux Online Installation

Do you want to make an online installation (Y or N)?

Y,y, N,n

Y

Enter “Y” to begin the online upgrade.

Linux Offline Installation

Do you want to make an online installation (Y or N)?

Y,y, N,n

N

Enter “N” to begin the offline upgrade.

-

Please enter the directory path of the .tar file for the Docker image 

-

-

For offline upgrade, mention the directory path of the .tar file for the Docker image.

For example, /opt/qtm 

Step 5: Verify QMetry Container Status

Run the following command to list the running containers.

docker ps

 

Step 6: Log in to QMetry

Open the QMetry application in your browser and verify it by logging in.

 

Step 7: Install or Upgrade QMetry Jira Add-on

Download the correct Jira add-on version that matches your QMetry version. Refer to the table below to find the compatible Jira add-on version based on your QMetry version.

QMetry Version

Jira-addon Version Required

8.19.1 and 8.20.0.2

2.3.2_jira9 (Jira Version 9x), 2.3.2 (Jira Version 10x)

8.19.0

2.3.1

8.18.1

2.3.0

8.17.1

2.2.8

8.17.0

2.2.7


🔗 For more information on QMetry Jira Integration, refer to the Steps to Install and Configure the QMetry Jira Integration app.

 

Reconfiguring SSL After Upgrading QMetry to the Latest Version

If you have configured SSL (https) in Tomcat inside the container, you must reconfigure it in the new Docker container.

If you encounter any issues during the upgrade, please submit a support ticket on the Support Portal.