Upgrade Document to v8.6 - for QMetry above v8.5.6.3 with MySQL 5.7.29 Upgrade

Steps to upgrade existing QMetry to latest version

Pre-requisites

Important Pre-requisites to check before upgrade to 8.6.


  • Proceed with this upgrade ONLY IF your current QMetry version is v8.5.6 or above. To check : Go to QMetry > About section.
  • Ensure internet connectivity is enabled on the server for this upgrade.


Below are the steps to be followed to upgrade your existing QMetry installation :

Step 1 : Download Required Files

  • Please write to QMetry Support by sending an Email at qtmprofessional@qmetrysupport.atlassian.net,  to get the latest version of QMetry Upgrade Installer.

  • Download the QMetry86x.zip and UpgradeMysql.zip to your QMetry Application Server once you receive it.

Step 2 : IMPORTANT : Backup your existing QMetry Database

Take the backup of your existing “qmetry” database. You can replace username, password, location of backup file (currently default /opt). Replace x with the mysql docker name seen in the output of command : docker ps

  • Syntax : docker exec qmetry85x_mysql_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 qmetry85x_mysql_1 sh -c 'exec mysqldump -uroot -pqmetry --triggers --routines --hex-blob --single-transaction --lock-tables --no-create-db qmetry' > /opt/qmetry_backup_2018-01-01.sql

Verify that your database has been backed up properly and is available for later use in case of any emergency.

Step 3. Run the MySQL Upgrade Utility.

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 command above)
    • docker start qmetry85_mysql_1
    • docker start qmetry_app_1

2. Go to the directory where the "UpgradeMysql.zip" files is downloaded.

  • Extract upgrademysql.zip file using unzip command:
    • unzip upgrademysql.zip
    • cd UpgradeMysql/QMetry
  • Give permission to upgrademysql.sh file through the following command
    • chmod +x upgrademysql.sh
  • Enter the following command and then pass the parameters mentioned
    • sudo sh upgrademysql.sh
  • The upgrade script will prompt the following option:


OptionsTypeDefault ValueComments/ Example
Please enter MySQL Docker Release Prefix (e.g. qmerty85)Mandatory

qmetry85

If docker name is qmetry85_mysql_1, it means the release prefix is qmetry85 (output available from docker ps command)

Wait for the process to complete.

3. Verify only 2 dockers should be running now : docker ps - and find qmetry_rds_1 and qmetry_app_1

4. Restart the dockers :

  • docker stop qmetry_app_1 qmetry_rds_1
  • docker start qmetry_rds_1
  • docker start qmetry_app_1


Step 4 : Run the QMetry Upgrade

1. Go to the directory where the QMetry86x.zip file is downloaded.

2. Check the running containers using the following command:

  • docker ps

3. Copy QMetry86x.zip file inside the docker container using the following command (replace x with the application container name seen in command above and the upgrade zip received) :

  • command : docker cp QMetry86x.zip qmetry_app_1:/opt
    • Note: Your current tomcat installed path in docker container would be /home/qmetry/QMetry.

4. Log into docker container, using the following command (replace x with the application container name seen in command : docker ps )

  • command : docker exec -it qmetry_app_1 bash

5. Go to /opt directory where the QMetry85.zip file is copied using command

  • cd /opt

6. Unzip the file under the /opt directory separate from your current installation path /home/qmetry/QMetry

  • unzip QMetry86x.zip

7. Go to QMetry directory:

  • cd QMetry86x

8. Give permission to qmetry.sh file through the following command

  • chmod +x qmetry.sh

9. Enter the following command and then pass the parameters mentioned
  • sh -x qmetry.sh

10. Utility will confirm if you want to upgrade, type Yes, and then specify the path of existing QMetry installation.

OptionsTypeDefault ValueComments/ Example
Do you want to upgrade the Existing version of QMetry?Mandatory

[No]

type - yes

Specify path of existing version of QMetry

Mandatory-

type - /home/qmetry/QMetry


Wait for the process to complete.

11. Exit from docker container once the process is completed, use the following command:

  • exit

Step 5 :Additional Tomcat and MySQL Configuration (Mandatory)

QMetry is installed with a default configuration of minimum and maximum heap memory utilization. You should modify these settings depending on your hardware configuration. Refer Additional Configurationfor more details.

Step 6 : Restart QMetry and MySQL Docker Container

  • Check the running containers using the following command:
    • docker ps
  • Restart both docker containers using below commands (Note : QMetry DB docker container name changes from qmetry85_mysql_1 to qmetry_rds_1 )
    • docker stop qmetry_app_1 qmetry_rds_1
    • docker start qmetry_rds_1
    • docker start qmetry_app_1
  • Note : In case you have configured Redis Caching for QMetry installed on same server OR a separate server - connect to that server and run the below commands :
    • To view existing containers : docker ps
    • Replace the container name seen in above command : docker exec -it container-name redis-cli FLUSHALL

Step 7 : Installing / Upgrading Jira add-on for Integration of QMetry and Jira.

Note: It is important to have correct version of Jira add-on installed in Jira based on your upgraded and current QMetry version. Refer below table for the right version of "Jira Integration - QMetry Enterprise".

QMetry VersionJira-addon version required
On v8.5.62.0.2 or above
On 8.5.6.32.0.3 or above
On 8.62.0.4 or above


Upgrade your Jira add-on as per the above compatibility matrix. In case you have not installed the Jira Integration - QMetry Enterprise add-on for integration, follow the Steps to Install and Configure the Jira Integration - QMetry Enterprise add-on, if it is not installed.

If you are having any issues during the upgrade process, write us at qtmprofessional@qmetrysupport.atlassian.net. This will automatically open a ticket with our support team and help you follow the progress.