Install/Upgrade Automation API Feature (RHEL8, RHEL9, RHEL10 & Podman)

Note

This documentation is for the installation of Automation API only on RHEL8, RHEL9 and RHEL 10 OS.

In this guide, we'll run you through the installation steps of Automation API. Installing the Automation API with your on-premise QMetry installations will enable several automation API related features including faster automation result file imports into QMetry.

Before you Start

Choose a Deployment Option

  • Option 1: Shared server: install the Automation API on the same server that runs the QMetry Application.

  •  Option 2 (recommended): Dedicated server: for heavy Automation API usage, install ActiveMQ, the Automation API, and Redis caching on a separate server.

If you are opting for Option 2, the following are hardware requirements for Active MQ and Automation API Server.

Small Teams

< 50 Users

Medium Teams

< 500 Users

Large Teams

500+ Users

Min

Recommended

Min

Recommended

Min

Recommended

Memory

4 Gb

8 Gb

8 Gb

16 Gb

16 Gb

32 Gb

CPUs

2 Core

4 Core

4 Core

12 Core

12 Core

24 Core

Prerequisites

Confirm all of the following before you begin:

  1. Pre-install QMetry Application. Refer QMetry and Reports Offline Installation on Linux - 2 Tier. Follow Steps 1 to 10  mentioned in the Install QMetry Application section. (Step 10 is mandatory).

  2. Configure ActiveMQ and Redis server with QTM Application.

  3. All the servers should support: unzip, curl, and vim.

  4. Get the QMetry_RHEL_Installer.zip files from QMetry Support.

  5. Enable internet access on both servers to install using podman, in case of online installation.

  6. Ensure Proxy Servers are not blocking downloads from the Internet.

  7. Install Podman and podman-compose utilities using the root user.

Required Ports

Installation

Ports that need to be enabled and should be available for use

Redis Caching Server

6379

Active MQ Server

8181 & 61616

Automation API Server

8081

Note

Perform the steps in order: download and transfer all images first, then install Redis, ActiveMQ, and the Automation API.

During an upgrade, the installer detects the existing component and skips the configuration prompts, reusing stored values.

Before you proceed with the installation

In case of offline installation

Step 1. Install podman and podman-compose tools. You can follow steps mentioned in the Podman and Podman Compose Installation section to install the tools. However, it is not mandatory to follow these specific guidelines for the installation of the tools.

Step 2. Download podman images of QMetry products.

Refer to Download and Restore Container Images of QMetry Products. Follow these steps on a machine where the internet is accessible so that the podman images can be downloaded on it.

Step 3. Restore the podman images of QMetry products on specific machine where the installation is to be carried out.

Refer to Restore Container Images of QMetry Products

Note

In case of rootless installation, it is mandatory to follow the steps mentioned for Podman and Podman Compose Installation.

Install/Upgrade Redis Server

Note

QMetry supports Redis 7.0.10 and later. Currently, the podman will be installed with Redis version 7.4.1.

Note

Configure the Redis with QMetry Application as mentioned in step 7. If you are facing any issues from the QMetry Application side after step 7, then you may be required to restart the QMetry Application podman container after Step 7.

  1. Extract the installer

    unzip QMetry_RHEL_Installer.zip
cd QMetry_RHEL_Installer

  2. Run the installer

    sudo su
chmod +x install.sh
./install.sh

  3. Online Install Prompt

    Options

    Allowed Values

    Default Value

    Recommended Value

    Do you want to make an online installation (Y/N)?

    Y,y,N,n

    Y

    Y

  4. Enter podman credentials provided by the support team.

  5. Enter 4 to install QMetry Redis

    image-20260331-061107.png

    The installation may take a while.

  6. Verify the containers

    podman ps

  7. Log into the QMetry application, perform the following steps:

    ff809a77-ac07-4c76-8fc5-ec00569b264f.png

    • Go to "Admin" Profile and Edit the Profile.

    • Update QMetry Redis URL

    For more details on Redis, visit https://redis.io/.

Install/Upgrade ActiveMQ

  1. Extract the installer

    unzip QMetry_RHEL_Installer.zip
cd QMetry_RHEL_Installer

  2. Run the Installer

    sudo su
chmod +x install.sh
./install.sh

  3. Online Install Prompt

    Options

    Allowed Values

    Default Value

    Recommended Value

    Do you want to make an online installation (Y/N)?

    Y,y,N,n

    Y

    Y

  4. Enter the podman credentials provided by the support team.

  5. Type 5 to install ActiveMQ.

    image-20260331-061107.png

    In case of upgrade, value for parameters won't be asked.

    Options

    Details

    Default Value

    Example

    Enter activemq username

    -

    -

    admin

    Enter activemq password

    -

    -

    admin

  6. Verify the containers

    podman ps

  7. Configure ActiveMQ in QMetry

    Log into the QMetry application.

    • Go to "Admin" Profile and Edit the Profile.

    • Update MQ URL, MQ Username, and MQ Password.

    The ActiveMQ URL should be in the format of protocol://<host>:port

    For example, "tcp://<activeMQ-Host>:61616"

    image-20231122-121848__1_.png

  8. Restart the QMetry Application podman container.

Install / Upgrade Automation API Server

  1. Copy the QMetry_RHEL_Installer.zip installation file received from QMetry Support to your server and unzip it. Go to the directory where these files are saved.

    unzip QMetry_RHEL_Installer.zip
cd QMetry_RHEL_Installer

  2. Run the installer

    sudo su
chmod +x install.sh
./install.sh

  3. Online Install Prompt

    Options

    Allowed Values

    Default Value

    Recommended Value

    Do you want to make an online installation (Y/N)?

    Y,y,N,n

    Y

    Y

  4. Enter the Podman credentials.

  5. Type 7 to install QMetry Automation API.

    image-20260331-061107.png

  6. Provide these values when prompted (skipped during an upgrade):

    Options

    Details

    Default Value

    Example

    Enter QMetry database host (localhost)

    For AWS, use the private IP of the instance hosting the QTM database

    localhost

    QTM Application's database host

    Enter QMetry (QTM) database port (3306)

    3306

    3306

    3306

    Enter QMetry (QTM) database schema (qmetry)

    qmetry

    qmetry

    qmetry

    Enter QMetry (QTM) database user (root)

    root

    root

    root

    Enter QMetry (QTM) database password

    -

    qmetry

    qmetry

    Enter QMetry (QTM) database min connection (32)

    -

    32

    32

    Enter QMetry (QTM) database max connection (50)

    -

    50

    50

    Enter min threads (2)

    -

    2

    2

    Enter max threads (2)

    -

    2

    2

    Enter Redis host (localhost)

    Note: In case of AWS installation enter the private IP of the AWS instance where Redis is installed.

    localhost

    redis host

    Enter Redis port (6379)

    -

    6379

    6379

    Enter MQ URL (tcp://localhost:61616):

    Note: In case of AWS installation enter the private IP of the AWS instance where Redis is installed. EG: tcp://10.0.0.16:61616

    tcp://localhost:61616

    tcp://<activeMQ-Host>:61616

    Enter MQ user (admin)

    -

    Match your ActiveMQ password

    admin

    Enter MQ password

    -

    -

    -

  7. Type 0 to exit the installer.

  8. Verify the container

    podman ps

Get support

For any installation issue, raise a ticket on the Support Portal.

In this section:
© 2026
Publication date: