Install/Upgrade Automation API Feature for Offline Installations

This guide covers installing or upgrading the QMetry Automation API on an on-premise QMetry deployment that has no direct internet access.

You download the Docker images on an internet-enabled machine, transfer them as .tar files, then load and configure each component on the target servers.

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

Pre-requisites

Confirm all of the following before you begin:

  1. QMetry Application is installed and running. Complete Steps 1–8 of the Install QMetry Application section (through entering the Base URL); Step 8 is mandatory. Refer QMetry and Reports Offline Installation on Linux - 2 Tier.

  2. Redis and ActiveMQ servers are configured with the QMetry Application. This guide installs both if you have not already.

  3. Install the following on the server:

    • CentOS, RHEL-8, RHEL-9 and RHEL 10

    • Docker Version 20.10.13

    • Docker Compose Version v2.40.3

    • Yum-tools

  4. Every server supports the commands: unzip, curl, and vim.

  5. You can run installation commands as the root user.

  6. You have QMetry_Linux_Installer.zip, plus Docker credentials, from QMetry Support.

  7. Each target server has Docker and Docker Compose installed, plus yum-utils, and Docker is set to start automatically on reboot.

  8. An internet-enabled machine is available to download the images, and it supports the docker command.

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.

Download and transfer the Docker Images

Perform these step on an internet-enabled machine.

  1. Log in to the Docker Registry.

    docker login

    Enter the Docker credentials when prompted. Contact QMetry Support if you do not have them.

  2. Pull, verify, save, and transfer the Redis image:

    docker pull qmetry/qmetry:redis741
    docker images
    docker save -o /opt/qtm/qmetryredis.tar
    qmetry/qmetry:redis741
    
  3. Pull, verify, save, and transfer the ActiveMQ image.

    docker pull docker.io/qmetry/qmetry:activemq_latest
    docker images
    docker save -o /opt/qmetryactivemq.tar docker.io/qmetry/qmetry:activemq_latest
    
  4. Pull, verify, save, and transfer the Automation API Image:

    docker pull qmetry/qmetry:automation_latest
    docker images
    docker save -o /opt/qtm/qmetryautomation.tar qmetry/qmetry:automation_latest
    

    Then transfer qmetryautomation.tar to the QMetry Automation API server.

Note

You can change the .tar output path in each docker save command. Use docker images after each pull to confirm the image downloaded successfully.

Install/Upgrade Redis Server

Note

QMetry supports Redis 7.0.10 and later. The Docker image currently installs Redis 7.4.1.

  1. On the QMetry Redis server, go to the directory holding the .tar file and load it, then verify:

    sudo docker load -i qmetryredis.tar
    sudo docker images    
  2. Extract the installer

    unzip QMetry_Linux_Installer.zip
    cd QMetry_Linux_Installer
  3. Run the installer

    sudo su
    chmod +x install.sh
    ./install.sh
  4. Enter response for installation Prompt

    Options

    Enter Value

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

    N

  5. Enter docker credentials and select 4 in the QMetry Installation Menu.

    image-20260331-061107.png

    The installation may take a while.

  6. Verify the containers

    docker ps
  7. Configure Redis in QMetry

    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/.

Note

If you face any issues in the QMetry Application after configuring Redis, then restart the QMetry Application Docker container after Step 2.3.

Install/Upgrade ActiveMQ

Get the QMetry_Linux_Installer.zip file from QMetry Support and copy it to the server for Automation API installation.

  1. On the ActiveMQ server, load and verify the transferred image:

    sudo docker load -i qmetryactivemq.tar
    sudo docker images
  2. Extract the installer

    unzip QMetry_Linux_Installer.zip
    cd QMetry_Linux_Installer
    
  3. Run the installer

    sudo su
    chmod +x install.sh
    ./install.sh
  4. Enter your response to the prompt

    Options

    Enter Value

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

    N

  5. Enter the Docker credentials. At the QMetry Installation Menu, select 7.

    image-20260331-061107.png

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

  6. Configure the parameters

    Options

    Example

    Enter activemq username

    admin

    Enter activemq password

    admin

    .tar file directory path

    For offline upgrade, the directory holding the image .tar, e.g. /opt/qtm

  7. Verify the containers

    docker ps
  8. Configure ActiveMQ in QMetry

    After the above steps are completed, 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
  9. Restart the QMetry Application docker container to apply the change.

Install / Upgrade Automation API Server

The installation may take a while.

  1. On the Automation API server, load and verify the transferred image:

    sudo docker load -i qmetryautomation.tar
    sudo docker images
  2. Extract the installer

    unzip QMetry_Linux_Installer.zip
  3. Run the Installer

    sudo su
    chmod +x install.sh
    ./install.sh
  4. Enter your response

    Options

    Enter Value

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

    N

  5. Enter the Docker credentials. At the QMetry Installation Menu, select 7 (QMetry Automation API).

    image-20260331-061107.png
  6. Enter configuration parameters

    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

    -

    -

    -

    .tar file directory path

    -

    -

    For offline upgrade, the directory holding the image .tar, e.g. /opt/qtm

  7. Verify the container

    docker ps

    Confirm the automation container appears in the list. Installation is complete once it is running.

 

Get support

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

Publication date: