QMetry Reports Upgrade for RHEL8, RHEL9 & Podman (from v8.11.2 and above)
Note
This document is applicable ONLY if your QMetry Reports version is 8.11.2 and above, and you want to upgrade to QMetry Reports version 8.27.0.
This guide is intended for users using QMetry v8.11.2 and above and outlines the steps to upgrade from an older version of QMetry to the latest release.
In this guide, we will run you through upgrading QMetry Test Management Reports in your environment. These steps are to be followed on your QMetry Reports server hosted on RHEL8 and RHEL9 OS machine.
As a part of this upgrade, which introduces reports sync via QMetry UI, it is required to open port 8080 on the reports server to accommodate the changes.
Proceed with this upgrade ONLY if your current QMetry Reports version is v8.11.2 or above.
Podman (and podman-compose) must be installed and running, and you must have sudo privileges.
The upgrade directory must contain the existing config.properties, the compose files (cdc.yml, sync.yml, and reportdb.yml for a fresh install), and, for an offline upgrade, the required .tar image files.
Upgrade Steps
Step 1: Download Required Files
You can generate a request on QMetry Support Portal, to get the latest version of QMetry Reports.
Download the QMetry_RHEL_Installer.zip file on your report server's /opt directory once you receive the report upgrade package.
Step 2. Run the upgrade script and choose online or offline
From the upgrade directory, run the script. You can let it prompt you, or pass the install type as an argument:
sudo su - chmod +x upgrade.sh ./upgrade.sh # you will be prompted for online/offline # or ./upgrade.sh Y # online upgrade (pulls images from registry) ./upgrade.sh N # offline upgrade (uses local .tar image files)
When prompted:
Do you want to make an online upgrade (Y/N)?
Press Enter to accept the default Y (online), type Y to pull images from the registry, or type N for an offline upgrade using local .tar files. The script then verifies the container engine and prerequisites before showing the upgrade menu.
Step 3. Select QMetry Report from the upgrade menu
Type 3 to select QMetry Report. The script prints the recommended CPU and memory guidance, then follows one of two paths depending on whether the Report CDC and Sync containers already exist.
Step 4. Respond to Upgrade Prompts
If the qmetry-report-cdc and qmetry-report-sync containers are detected, the script uses the simplified path: it backs up the existing config.properties, stops and removes the old CDC and Sync containers (waiting ~15 seconds for graceful shutdown), cleans up old images, then starts the new CDC and Sync containers. No MQ or resource prompts appear in this path.
If you chose an offline upgrade, you will be asked for two image directories:
Prompt | Input / Example |
|---|---|
Please enter directory path of qmetrycdc.tar file for docker image | Full path to the directory containing qmetrycdc.tar (e.g. /path/to/docker/images) |
Please enter directory path of qmetrysync.tar file for docker image | Full path to the directory containing qmetrysync.tar |
Scenario B — Fresh installation (CDC & Sync not running)
If the CDC and Sync containers are not found, the script performs a full install. It first checks that the Report database container exists — if it prints “QMetry Report database container is not running. Contact QMetry Support!”, stop and contact support. It then backs up the old configuration, removes the legacy qmetry-reports container, old report DB container, images, and unused volumes/networks. Database settings (host, port, user, password, schema, and analytics DB settings) are read automatically from config.properties — no input needed. You are then prompted for the following:
Prompt | Default | Example |
|---|---|---|
Enter MQ URL | - | Message Queue broker URL (e.g. tcp://localhost:61616) |
Enter MQ UserName | — | MQ broker username |
Enter MQ Password | — | MQ broker password |
Enter Maximum memory to allocate for CDC app in GB(s) | 4 | Memory in GB (number only) |
Enter Maximum memory to allocate for Sync app in GB(s) | 8 | Memory in GB (number only) |
Enter Number of CPU's to allocate for CDC app | 4 | Number of CPUs (number only) |
Enter Number of CPU's to allocate for Sync app | 4 | Number of CPUs (number only) |
For an offline fresh install, you are additionally asked for three image directories — for qmetryreportdb.tar, qmetrycdc.tar, and qmetrysync.tar. The script then installs the Report database container using reportdb.yml, starts the CDC and Sync containers, and initializes the sync job.
Note
In both scenarios the script waits about 10 seconds after starting each of the CDC and Sync apps, then prints the list of running containers followed by “QMetry Report has been upgraded successfully!” and returns to the main upgrade menu.
Step 5. Configure Force Sync of Reports and trigger a sync (post-upgrade)
In the QMetry UI, under the Sync Data tab, set up the Report Data Sync from your reports server to QMetry Reporting.
Report Server URL: set this to your report server domain URL followed by the reports sync port. Ensure that port is open on the reports server.
Click Test to confirm a successful connection, then click Test & Save.
Click Sync Data to start the Reports Data Sync.
Note
“Sync Data” should be run after the upgrade. The time taken to sync depends on the amount of data in QMetry. QMetry custom reports remain inaccessible while syncing is in progress, so the sync is recommended to be run only during off-peak hours. Users can start using QMetry Reports once the sync is completed.
Step 6. Verify the upgrade
Confirm all containers are running:
podman ps
Check the CDC and Sync container logs for errors, and access the QMetry Report UI on the configured port to confirm functionality.
If you face any issues during the upgrade process, generate a support ticket on the Support Portal for assistance.