Pre-requisites for QMetry Application and Report Server Installation

This document lists the checks to complete before you install the QMetry application or the QMetry report server.

This guide uses a two-tier architecture as an example: one Linux server for the QMetry application and one Linux server for QMetry Reporting. For other deployment topologies, follow the QMetry Deployment document to finalize your architecture.

Prerequisite Checklist

Confirm each of the following items. The sections that follow explain how to verify and resolve each of these pre-requisites.

Prerequisite

What to confirm

Required commands

unzip, curl, and iptables are installed on every server.

Internet access

Every server can reach the internet for Docker installation.

Firewall and SELinux

Both are disabled on every server during installation.

Both are disabled on every server during installation.

No proxy blocks downloads from the internet.

Server communication

The application and report servers can reach each other on the required ports.

Open ports

Ports 80, 443, and 3306 are free on the relevant servers.

Root access

Run all the commands with root user access.

Disk space

The Docker and data directories have enough free space.

Installation files

You have the files and Docker credentials from QMetry Support.

Note

To install using a non-root user, refer to Installing QMetry as a Standard User before starting the install on both QMetry and Report servers.

The example commands use yum. On Ubuntu, use apt instead (for example, apt install unzip -y).

Verify the Required Commands

Every server must support the unzip, curl, and iptables commands. To confirm that these commands are installed, perform the following steps:

  1. Login to the server.

  2. Run the following commands

    rpm -qa | grep unzip 
    rpm -qa | grep curl
    rpm -qa | grep iptables

Each command returns the package name if the command is installed. If a command returns no result, install the missing package.

Install Commands

To install any command that is not present, perform the following steps:

  1. Login to the server(s).

  2. Run the command for each package you need to install:

    yum install unzip -y
    yum install curl -y
    yum install iptables -y

Verify Internet Access on Server

Enable internet access on all servers so that Docker can download the required images. To confirm connectivity, run the following command:

 ping google.com

Confirm proxy settings

Confirm that no proxy server blocks downloads from the internet. If your network uses a proxy, configure it to allow the QMetry servers to reach the Docker registry.

Disable Firewall and SELinux

Disable both the firewall and SELinux on all servers before you install QMetry and QMetry QMetry .

Note

Disable the firewall and SELinux only for the duration of the installation. After installation, re-enable both and open the required ports (80, 443, and 3306).

Disabling Firewall

To disable firewall, perform the following steps:

  1.  Check whether the firewall is running:

    systemctl status firewalld (or) 
    firewall-cmd --state
    
  2. Stop and disable the firewall:

    systemctl stop firewalld
    systemctl disable firewalld
    

Disabling SELinux

To disable SELinux, perform the following steps:

  1. To check the SELinux status, run the following command:

    getenforce

    The command reports enforcing, permissive, or disabled.

  2. If the status is not disabled, disable SELinux as follows:

    1. Open the /etc/selinux/config file.

    2. Set the SELINUX value to disabled: (SELINUX=disabled).

    3. Save the file and restart the server.

Verify Server Communication

The application server and the report server must be on the same network and able to communicate with each other. Confirm the following:

  • QMetry Application Server and Report Server should be in the same network.

  • The report server can reach the QMetry application server on ports 80 and 443, and the database server on port 3306 (or your configured database port).

Verify the Required Ports are Open

The ports 80/443 and 3306 should be free on the relevant servers.

To test whether a port on a remote server is open, use any of the following commands. Replace the host IP address and port with your values.

Command

Purpose

if command not found then run

telnet <host IP> <host port>

Tests a connection to a specific port.

yum install telnet -y

nc -vz <host IP> <host port>

Tests connectivity without sending data.

yum install nc -y

nmap -p <host port> <host IP>

Scans a specific port on the host.

yum install nmap -y

netstat -tunlp

Lists local listening ports.

yum install net-tools -y

ss -nutlp

Lists local listening ports (alternative to netstat).

-

Confirm Root Access

Docker installation requires root user access. Switch to the root user with the command that matches your environment.

sudo su (for EC2 instance)
su - (for Centos / Red Hat)

Confirm Disk Space

  • Docker is installed under (/var/lib/) directory.

  • Allocate enough space for QMetry to store your data.

Disk Space Allocation for Database

  • QMetry database data is saved under: /var/lib/docker/volumes/qmetry_mysql_data/_data.

  • To check disk space at directory level, run the below command:

    df -h

Get the Installation Files

Request the following files and credentials from QMetry Support before you begin the installation:

  1. QMetryApp.zip

  2. QMetryReport.zip

  3. Docker Credentials for installation.

After you complete every check in this document, you are ready to install QMetry. Continue with the QMetry application and report server installation guides.

Publication date: