QMetry App Upgrade Guide for Linux (from 8.25.2.2 and above to Latest)

This document provides step-by-step instructions to upgrade QMetry to version 8.29.0.

Note

Perform the upgrade only during a scheduled downtime window when no traffic reaches the application.

System Requirements and Prerequisites

Before upgrading, ensure the following:

  • The MySQL version for both QMetry Reports and the QMetry application is 8.4.8.

  • The server has an internet connection, if the upgrade process requires one.

  • The server has enough free disk space for the database backup and the upgrade files.

  • No users or integrations send traffic to the application during the upgrade.

  • You have a current backup of the QMetry database.

Upgrading Existing QMetry Installation

if your QMetry version is 8.25.2.2 and above then the below steps are applicable:

Step 1: Important: Backing Up the Existing QMetry Database

A backup lets you restore QMetry if the upgrade fails. By default, the backup file is saved in the /opt directory on the host machine.

To back up the database, do the following:

  1. On the host machine, run the following command. Replace <password> with the MySQL root password and <date> with the current date. If needed, change the 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>.sql
    Example 17. 
    docker exec qmetryapp_db sh -c 'exec mysqldump -uroot -pqmetry --triggers --routines --hexblob
    --single-transaction --lock-tables --no-create-db qmetry' > /opt/qmetry_backup_2021-01-
    01.sql


  2. Verify that the database backup was successfully created and is available before proceeding with the upgrade.

Step 2: Download the Upgrade Files

To download the upgrade installer, do the following:

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

  2. Download QMetry8290.zip to the QMetry Application Server on the host machine.

Step 3: Run the QMetry Upgrade

  1. On the host machine, list the running containers:

    docker ps
  2. If the QMetry containers are not running, run the following commands:

    docker start qmetryapp_db
    docker start qmetry_app_1
  3. Go to the directory that contains the QMetry8290.zip file.

  4. Copy the upgrade file into the QMetry application container:

    docker cp QMetry8290.zip qmetry_app_1:/opt

    The current Tomcat installation path inside the Docker container is:

    /home/qmetry/QMetry
  5. Log in to the QMetry application container:

    docker exec -it qmetry_app_1 bash
  6. Go to the /opt directory where the upgrade file was copied:

    cd /opt
  7. Unzip the upgrade package:

    unzip QMetry8290.zip

    Ensure that the extracted upgrade directory is separate from the current installation path:

    /home/qmetry/QMetry
  8. Go to the extracted QMetry upgrade directory:

    cd QMetry8290
  9. Grant execute permission to the upgrade script:

    chmod +x upgrade_qmetry.sh
  10. Run the upgrade script:

    sh upgrade_qmetry.sh
  11. When the script prompts you to confirm, respond as described in the following table:

    Option

    Type

    Default Value

    Comments/Example

    Do you want to proceed with the QMetry upgrade (Y/N)?

    Mandatory

    -

    Enter Y to proceed or N to exit

  12. The upgrade can take some time to complete.

    Important

    Do not interrupt the upgrade script, and do not stop or restart the containers until the script finishes.

  13. After the upgrade completes successfully, exit the container:

    exit

Step 4: Restart QMetry and MySQL Containers

To restart the containers, do the following:

  1. On the host machine, list the running containers:

    docker ps
  2. Stop both containers, and then start the database container followed by the application container:

    docker stop qmetry_app_1 qmetryapp_db
    docker start qmetryapp_db
    docker start qmetry_app_1
  3. Verify that both containers are running successfully:

    docker ps

Step 5: Verify the upgrade

To confirm that the upgrade succeeded, do the following:

  1. Open the QMetry application in a browser.

  2. Log in to confirm that users can sign in.

  3. Confirm that the application works as expected.

  4. Check key application functionality and integrations.

  5. Confirm that QMetry displays version 8.29.0

Note

Keep the database backup from Step 1 until you have fully validated the upgrade.

Step 6: 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.

Table 21. Install or Upgrade QMetry Jira Add-on

QMetry Version

Jira-addon version required

8.29.x

2.4.6_jira10 (Jira Version 10x), 2.4.6 (Jira Version 11x)

8.28.x

2.4.5_jira10 (Jira Version 10x), 2.4.5 (Jira Version 11x)

8.27.x

2.4.3_jira10 (Jira Version 10x), 2.4.3 (Jira Version 11x)

8.26.x

2.4.2_jira10 (Jira Version 10x), 2.4.2 (Jira Version 11x)



Ask Support

If you encounter issues during or after the upgrade to QMetry v8.29.0, create a support ticket on the QMetry Support Portal. Include the upgrade logs and any error messages in the ticket.

Publication date: