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

Overview

This document is intended for QMetry customers running QMetry on Linux. It outlines the steps to upgrade QMetry from an older version (below v8.16.0.1) to the latest available release in online mode.

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.

Upgrading QMetry for Linux

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

Step 1: Important: Backing up the Existing QMetry Database

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

1. Create a backup of the "qmetry" database. By default, the backup is saved in the /opt directory.

2. Run the following command to update 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

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

Step 2: Downloading the Upgrade Files

Download the required files by following these steps:

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

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

Step 3: Running Upgrade Script

To run the upgrade script, perform the following steps:

1. List the running containers with the following command:

docker ps

If Docker is not running, use the following command to start it:

docker start qmetryapp_db
docker start qmetry_app_1

2. Go to the directory where the QMetryApp.zip file is downloaded and unzip the file on the host machine:

unzip QMetryApp.zip

3. Go to the QMetry directory:

cd QMetryApp

4. Run the following command to grant execution permissions to the upgrade script:

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

5. Run the following command to execute the upgrade script:

./upgrade.sh

6. Confirm to upgrade:

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

Step 4: Restarting QMetry and MySQL Docker Container

• List the running containers using the following command:

docker ps

• Restart both Docker containers using the following commands: 

docker stop qmetry_app_1 qmetryapp_db
docker start qmetryapp_db
docker start qmetry_app_1

Step 5: Installing or Upgrading 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.

🔗 If the QMetry Jira Integration app is not installed, follow 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. For more information on configuring SSL, refer to the SSL Certificate Configuration for Tomcat in Docker document.

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