QMetry Upgrade Document (to the Latest Version)
Overview
This document provides step-by-step instructions to upgrade QMetry to the latest version. It includes prerequisites, backup guidelines, and detailed steps to ensure a smooth and successful upgrade process with minimal downtime.
System Requirements and Pre-requisites
Before upgrading, ensure the following:
MySQL version of QMetry Reports and QMetry Application is 8.0.40.
Internet connectivity is enabled on the server.
Upgrading the Existing QMetry Installation
To upgrade QMetry to the latest version, perform the following steps:
Step 1: Important: Backing up the Existing QMetry Database
Create a backup of the "qmetry" database. By default, the backup is saved in the /opt directory.
Run the following command to update the username, password, and location of the backup file:
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>.sqlExample
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_2021-01-01.sqlVerify 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
QMetry82002.zipto the QMetry Application Server on the host machine.
Step 3: Running the QMetry Upgrade
To run QMetry Upgrade, perform the following steps:
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
Replace the container names with the correct application names as specified in the previous command.
2. Go to the directory where the QMetry82002.zip file is downloaded. Copy the file inside the Docker container using the following command:
docker cp QMetry82002.zip qmetry_app_1:/opt
Your current Tomcat installed path in Docker container is /home/qmetry/QMetry.
Log in to the Docker container using the following command:
docker exec -it qmetry_app_1 bash
Go to /opt directory where the QMetry82002.zip file is copied using the following command:
cd /opt
Unzip the file under the /opt directory, separate from your current installation path - /home/qmetry/QMetry
unzip QMetry82002.zip
Go to the QMetry directory:
cd QMetry82002
Run the following command to grant execution permissions to the upgrade script.
chmod +x upgrade_qmetry.sh
9. Run the following command.
sh upgrade_qmetry.sh
The process may take some time to complete. Kindly be patient and allow it to finish properly.
Step 4: Verify Upgrade Completion
The upgrade utility will prompt you to confirm whether you want to proceed with the upgrade.
Options | Type | Default Value | Comments/ Example |
|---|---|---|---|
Do you want to proceed with the QMetry upgrade (Y/N)? | Mandatory | - | type - Y/N |
Exit from the Docker container once the process is completed, use the following command:
exit
Step 5: Restart 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 6: 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 |
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 facing any issues during the upgrade process, generate a support ticket on Support Portal for assistance.