QMetry Offline Upgrade Document for Linux (from below v8.16.0.1 to the latest version)
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.
Pre-requisite
Upgrade files need to be prepared on any machine having internet connectivity and docker installed. The prepared upgrade files are then moved to the server along with QMetryApp.zip. Docker installation is required before executing the following docker commands on the machine.
Download Docker Images of QMetry
Follow these steps on the Internet-enabled machine on which the docker images of QMetry are to be downloaded.
Step 1. Execute the following command. Next, it will ask for docker's credentials. Enter the required credentials. Please contact QMetry Support, if you do not have the credentials.
docker login
After entering docker credentials, it will show the success message as shown below.
Step 2. Execute the following commands to pull QMetry application's docker image from the docker repository.
docker pull qmetry/qmetry:latest
The download process is started. Wait till the time it gets finished.
After the process gets finished, it will display the message as shown below.
Execute the following command to verify that docker image has been downloaded.
docker images
Step 3. Execute the following command to save QMetry application's docker image as .tar file. You can change the path of .tar file in the following command.
docker save -o /opt/qtm/qmetryapp.tar qmetry/qmetry:latest
Step 4. Execute the following commands to download and save alpine's docker image.
docker pull alpine:latest
docker save -o /opt/qtm/alpine.tar alpine:latest
docker images
Step 5. Transfer the qmetryapp.tar and alpine.tar file to the QMetry application server.
Steps to upgrade QMetry to latest version
Pre-requisites
Important Pre-requisites to check before upgrade to latest version.
MySQL version of QMetry Reports and QMetry Application should be 8.0.40.
SSL configuration would need to be redone as a new docker gets installed. You can refer to the article SSL Certificate Configuration for Tomcat in Docker.
Special Notes
You need to update all the packages of host OS on which the docker container has been installed. After upgrading QMetry to v8.10.3 & above, it is recommended to perform the following steps to upgrade the packages on host OS.
1. Stop docker service. Command may be Linux OS dependent, but it can be like
service docker stop
or
systemctl stop docker
2. Update all the package of host OS. Command may be Linux OS dependent, but it can be like
sudo yum update -y
or
sudo apt-get update -y
3. Step-2 will upgrade version of docker to the latest available version.
4. Start docker service. Command may be Linux OS dependent, but it can be like
service docker start
or
systemctl start docker
Upgrade Existing QMetry Installation
Follow the steps mentioned below to upgrade your existing QMetry installation:
Step 1: IMPORTANT: Backup your existing QMetry Database
Take the backup of your existing “qmetry” database. You can replace the username, password, 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_2021-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 commands.
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 | N | Enter “N” to begin the offline upgrade. |
Please enter directory path of .tar file for docker image | - | - | For offline upgrade, mention the directory path of .tar file for docker image. e.g., /opt/qtm |
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 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 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 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 Offline Installations.