Steps to upgrade existing QMetry to the latest version

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

Step 1 : Download Required Files

• You can generate a request on the QMetry Support Portal, to get the latest version of QMetry Upgrade Installer.

• Download the QMetry8713.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 the username, password, location of the backup file (currently default /opt).

• Syntax : docker exec qmetry_rds_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 qmetry_rds_1 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 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 qmetry_rds_1
  • docker start qmetry_app_1

2. Go to the directory where the QMetry8713.zip file is downloaded.

3. Copy QMetry8713.zip file inside the docker container using the following command

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

4. Log in to the docker container, using the following command

• command : docker exec -it qmetry_app_1 bash

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

• cd /opt

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

• unzip QMetry8713.zip
  

7. Go to QMetry directory:

• cd QMetry8713

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

• chmod +x qmetry.sh

• sh -x qmetry.sh

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

Wait for the process to complete.

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

• exit

Step 4 : 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 Configuration for more details.

Step 5 : Restart QMetry and MySQL Docker Container

• Check the running containers using the following command:
  • docker ps
• Restart both docker containers using the below commands (Note : QMetry DB docker container name is changed 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 the 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 the above command : docker exec -it container-name redis-cli FLUSHALL

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

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.

Important Note

• If you've upgraded to 8.7.1.1 and above - it is mandatory to run API to sync Jira project metadata to QMetry after upgrade or above versions.