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 |
Pre-requisites
Confirm all of the following before you begin:
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).
Configure ActiveMQ and Redis server with QTM Application.
All the servers should support: unzip, curl, and vim.
Get the QMetry_RHEL_Installer.zip files from QMetry Support.
Enable internet access on both servers to install using podman, in case of online installation.
Ensure Proxy Servers are not blocking downloads from the Internet.
Install Podman and podman-compose utilities using the root user.
The following Ports should be open:
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.
Step 1. 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.
Step 1: Extract the installer
unzip QMetry_RHEL_Installer.zip cd QMetry_RHEL_Installer
Step 2: Run the Installer
sudo su chmod +x install.sh ./install.sh
Step 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 |
Step 4: Podman Verification
Enter podman credentials provided by the support team.
Step 5: Main Installation Menu
Type 4 to install QMetry Redis.
The installation may take a while.
Step 6: Verify the containers
podman ps
Step 7: Configure Redis in QMetry
Log into the QMetry application, perform the following steps:
Go to "Admin" Profile and Edit the Profile.
Update QMetry Redis URL
 |
For more details on Redis, visit https://redis.io/.
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.
Step 2. Install/Upgrade ActiveMQ
2.1 Extract the installer
unzip QMetry_RHEL_Installer.zip cd QMetry_RHEL_Installer
2.2 Run the Installer
sudo su chmod +x install.sh ./install.sh
2.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 |
2.4 Podman Verification
Enter the podman credentials provided by the support team.
2.5 Main Installation Menu
Type 5 to install ActiveMQ.
In case of upgrade, value for parameters won't be asked.
Options | Details | Default Value | Example |
|---|---|---|---|
Enter activemq username | - | - | admin |
Enter activemq password | - | - | admin |
The installation may take a while.
2.6 Verify the container
podman ps
2.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"
 |
2.8 Restart the QMetry Application podman container.
Step 3: Install / Upgrade Automation API Server
3.1 Extract the installer
Copy the QMetryAutomationAPI.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
3.2 Run the Installer
sudo su chmod +x install.sh ./install.sh
3.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 |
3.4 Podman verification
Enter the Podman credentials.
3.5 Main Installation Menu
Type 7 to install QMetry Automation API.
3.6 Enter configuration parameters
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 | - | - | - |
The installation may take a while. Type 0 to exit the installer.
3.7 Verify the container
podman ps
Confirm the automation container appears in the list.
Get support
For any installation issue, raise a ticket on the Support Portal.