QMetry Online Upgrade Guide for RHEL8 and RHEL 9 using Podman

QMetry Online Upgrade Guide for RHEL8 and RHEL 9 using Podman

image-20240729-123126.png

 

Notes

 

Overview

This document is intended for customers running QMetry containers on RHEL 8 or RHEL 9 using Podman. It outlines the steps to upgrade from an older version of QMetry to the latest release. In addition to upgrading QMetry, it also includes the upgrade of Apache Tomcat to version 11.0.5.

The guide provides detailed instructions for backing up the QMetry database, upgrading the application, updating containers, and configuring SSL and Jira integration.

System Requirements and Pre-requisites

Before upgrading, ensure the following:

  • MySQL version for both QMetry Reports and QMetry Application is 8.0.40.

  • Internet connectivity is enabled on the server.

 

QMetry Upgrade Process for RHEL 8 and RHEL 9 using Podman

To upgrade the existing QMetry installation, perform the following steps:

Step 1: Important: Backup the Existing QMetry Database

To backup your existing QMetry database, perform the following steps:

  1. Take a backup of the "qmetry" database. The backup is saved in /opt by default.

  2. Run the following command to replace the username, password, and backup file location.

podman 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: 

podman exec qmetryapp_db sh -c 'exec mysqldump -uroot -pqmetry --triggers --routines --hex-blob --single-transaction --lock-tables --no-create-db qmetry' > /opt/qmetry_backup_2023-01-01.sql
  1. Verify that the database is backed up and is available.

 

Step 2: Download the Upgrade Files

Download the required files by following these steps:

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

  • Download RHELQMetryAppTomcatUpgrade.zip to the QMetry Application Server on the host machine.

 

Step 3: Run Upgrade Script

To run QMetry Upgrade, perform the following steps:

  1. To list the running containers, run the following command:

podman ps

 

If podman is not running, run the following command:

podman start qmetryapp_db podman start qmetry_app_1

 

Make sure to replace the container names with the appropriate application names as specified in the previous command.

  1. Go to the directory where the RHELQMetryAppTomcatUpgrade.zip file is located and unzip the file RHELQMetryAppTomcatUpgrade.zip on the host machine. 

unzip RHELQMetryAppTomcatUpgrade.zip
  1. Go to the extracted QMetry directory.

cd RHELQMetryAppTomcatUpgrade
  1. Run the following command to grant execution permissions to the upgrade script.

chmod +x upgrade.sh

 

Validate the name of your existing container and license volume in the upgrade.sh file before running it.

To validate the name of your existing container and license volume, perform the following steps:

  1. Run the following command to check the Podman volumes' names

podman volume ls

Podman volume name should be qmetry_license.

  1. Run the following command to check the Podman containers' names

podman ps

The Podman container name should be qmetry_app_1. 

  1. If the names differ, update the upgrade.sh file with the correct values with these steps:

    • Open upgrade.sh in edit mode.

    • Run the following command:

    • vi upgrade.sh
    • Update the file with the correct volume and container names.

    • Press i to change the file mode to insert.

    • Update the variables according to the existing volume and container name.

    • exist_license_volume → Value from podman volume ls for license  exist_qmetry_container → Value from podman ps for qmetry
    • Press Esc, and then type:wq to save the changes. 

  1. Run the upgrade script:

sh upgrade.sh 

  The process may take some time to complete. Kindly be patient and allow it to finish properly.

 

Step 4: Verify QMetry Container Status

Run the following command to list the running containers.

podman ps

 

Step 5: Login into QMetry

Open the QMetry application in your browser and verify it by logging in.

 

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

🔗 For more information on QMetry Jira Integration, refer to the Steps to Install and Configure the QMetry Jira Integration app.

 

Reconfiguring SSL After Upgrading QMetry to the Latest Version

If you have configured SSL (https) in Tomcat inside the container, you must configure it in the new container.

If you encounter any issues during the upgrade, please submit a support ticket on the Support Portal.