08. Manager 8.4.4 Cluster and Load Balancer Installation Guide for Windows

In this guide, we will run you through step by step to install qTest Manager v8.4.4 on a multiple Windows machines. Please go through the guide below thoroughly before starting your installations.

Before you begin

Before you install qTest Manager, make sure following things are done:

  • Your machine needs to satisfy qTest Manager's recommended hardware requirements
  • Prerequisite applications must be installed and running prior to upgrading qTest
    • PostgreSQL v9.5
    • RabbitMQ v3.5.4
    • Redis v2.8.19
    • Java JDK v8

Install Prerequisite Softwares

Please follow this instruction to install prerequisite app(s) as mentioned above

Install qTest Manager with Clustering Model

Overview

Using the clustering model, you will need to install and configure a Notification node and an Application node qTest Manager using the same qTest Manager's installation package.

To deploy qTest Manager on multiple servers, you will only need to install the highlighted components in the diagram below. We will be using it as a sample deployment model in this article. However, you can customize it base on your organization's needs.

Clustering

  • Server 1: The Notification node is installed on the same server with prerequisite apps, including Redis and Rabbit MQ. It connects to Server 2
  • Server 2: PostgreSQL is installed on this server
  • Server 3: The Application node is deployed on this server. It connects to the Server 1 and Server 2
  • A shared network drive is configured on Server 1. It should be accessible from the Notification node as well as the Application node to store attachments and search index
  • Notification node and application node must use the same PostgreSQL database schema and RabbitMQ virtual host
  • Users can access to qTest Manager via the Application node's URL

The installation process includes the following steps:

  1. Install the Notification node
  2. Install the Application node
  3. Start the nodes
  4. Configure your qTest Manager instance

Install the Notification node

  1. Download qTest Manager's installation package here
  2. Once downloaded, double click on the installer to start the installing process. Click Next to review the EULA
    1 - Welcome
  3. Select "I accept the terms in the License Agreement", then click Next to move on to the next page
    2 - EULA
  4. You will be given 2 options to perform the installation. Select the Express install option and then click Next
    • The Express install option will allow you to install qTest OnPremise with all default configurations, such as Installation directory, program menu directory, default data and attachment directory
    • The Custom install option will allow you to specify your installation configurations manually, such as Installation directory, web port, database port and attachment folder directory
    3 - Installation option
  5. Review the default Installation settings then click Install
    4 - Installation settings
  6. The installer will starts extracting files
    5 - Extract
  7. After the extracting process completes, you will have 2 options to deploy qTest Manager. Select the option Load balancing to deploy qTest Manager on multiple servers
    6 - Config options
  8. Next, specify a few ports from which the Notification node is accessible

    By default, the Configuration Wizard has already indicated 3 port numbers for HTTP, Admin and HTTPS ports as follows:

    • HTTP port: 8080
    • Admin port: 8005
    • AJP port: 8009
    • HTTPS port: 8443

    However, you can freely define any of the server's available ports by selecting Use custom ports. Simply enter the port numbers for each of the 4 port types

    7 - Web server ports
  9. In the next screen, you will have an option to enable a secured connection (HTTPS) to the Notification node

    If you have an existing certificate, you need to specify the locations of the Certificate file and the Private Key file by clicking the Browse button.

    You can optionally provide your Chain Certificate, which is your certification authority's certificate.

    8 - SSL
  10. You may also change the default location to store attachments

      IMPORTANT: Remember that the directory should be located in a shared network drive. All nodes must use the same directory and be able to create files under it


    9 - Data Dir
  11. You are required to configure the connection to your database. Database host, port and the credentials are required. You can either create a new database schema or use an existing one

      IMPORTANT: database password must not include @ character

    10 - DB config
  12. Similarly, as the above step, configure the database connection for the integration database
    11 - Poseidon config
  13. Specify the connection to your Redis server, including its host and port
    12 - Redis
  14. Specify the informaton to connect to RabbitMQ server, including its host, ports, qTest Manager's virtual host in the server, and the credential to log in to the virtual host
    13 - RabbitMQ
  15. Configure the Notification node: select Run as Notification server
    14 - Noti config
  16. After you have input all required information and click Next, the wizard starts configuring the database and qTest Manager service
    15 - Config
  17. After this process is done, you will be directed to the final information screen, where you can review all the installed components and their settings
    16 - Complete

Install the Application node

  1. Download qTest Manager's installation package here
  2. Once downloaded, double click on the installer to start the installing process. Click Next to review the EULA
    1 - Welcome
  3. Select "I accept the terms in the License Agreement", then click Next to move on to the next page
    2 - EULA
  4. You will be given 2 options to perform the installation. Select the Express install option and then click Next
    • The Express install option will allow you to install qTest OnPremise with all default configurations, such as Installation directory, program menu directory, default data and attachment directory
    • The Custom install option will allow you to specify your installation configurations manually, such as Installation directory, web port, database port and attachment folder directory
    3 - Installation option
  5. Review the default Installation settings then click Install
    4 - Installation settings
  6. The installer will starts extracting files
    5 - Extract
  7. After the extracting process completes, you will have 2 options to deploy qTest Manager. Select the option Load balancing to deploy qTest Manager on multiple servers
    6 - Config options
  8. Next, specify a few ports from which this Application node is accessible

    By default, the Configuration Wizard has already indicated 3 port numbers for HTTP, Admin and HTTPS ports as follows:

    • HTTP port: 8080
    • Admin port: 8005
    • AJP port: 8009
    • HTTPS port: 8443

    However, you can freely define any of the server's available ports by selecting Use custom ports. Simply enter the port numbers for each of the 4 port types

    7 - Web server ports
  9. In the next screen, you will have an option to enable a secured connection (HTTPS) to the Notification node

    If you have an existing certificate, you need to specify the locations of the Certificate file and the Private Key file by clicking the Browse button.

    You can optionally provide your Chain Certificate, which is your certification authority's certificate.

    8 - SSL
  10. Specify the directory to store attachments

      IMPORTANT: Remember that the directory should be located in a shared network drive. All nodes must use the same directory and be able to create files under it


    9 - Data Dir
  11. You are required to configure the connection to your database. Database host, port and the credentials are required. You can either create a new database schema or use an existing one

      IMPORTANT: database password must not include @ character

    10 - DB config
  12. Similarly, as the above step, configure the database connection for the integration database
    11 - Poseidon config
  13. Specify the connection to your Redis server, including its host and port
    12 - Redis
  14. Specify the informaton to connect to RabbitMQ server, including its host, ports, qTest Manager's virtual host in the server, and the credential to log in to the virtual host
    13 - RabbitMQ
  15. Configure the connection to the Notification node: select Run as Application server and specify the URLs to connect to the Notification node:
    • Internal URL: the URL to connect to the Notification node from the internal network
    • External URL: the URL to connect to the Notification node from the Internet

    Run as app server
  16. After you have input all required information and click Next, the wizard starts configuring the database and qTest Manager service
    15 - Config
  17. After this process is done, you will be directed to the final information screen, where you can review all the installed components and their settings
    16 - Complete

Configure qTest Manager

After qTest Manager has been installed successfully, access to the Notification node to configure your qTest Manager instance and import license file following this instruction:

  • If SSL is disabled: http://[notification_node_ip]:[HTTP_PORT]
  • If SSL is enabled: https://[notification_node_ip]:[HTTPS_PORT]

Similarly, you will also need to import license file to the application node:

  • If SSL is disabled: http://[application_node_ip]:[HTTP_PORT]
  • If SSL is enabled: https://[application_node_ip]:[HTTPS_HTTPS_PORT]

Install qTest Manager with Load Balancing Model

Overview

In case your team size is large (more than 1000 total users or 250 concurrent users), please consider the load balancing model as below. The model is quite the same as the clustering model, but you can add more Application nodes and then configure a load balancer.

Load balancing

  • Server 1: the Notification node is installed on the same server with Prerequisite applications, including Redis and RabbitMQ
  • Server 2: PostgreSQL server
  • Server 3: The Application node as in the clustering model
  • Server 4: This is the additional Application node. Installing the Application node is the same as instructed in the clustering model
  • A shared network drive is configured on Server 1. It should be accessible from the Notification node as well as all Application nodes to store attachments and search index
  • Notification node and Application nodes must use the same PostgreSQL database schema and RabbitMQ virtual host
  • After all of the nodes have been installed, please restart the Notification node first and then all of the Application nodes
  • You will need to configure the Application nodes with your Load Balancer. You can use any load balancing tools or services which are being used in your organization. We do not provide the instruction to configure the Load Balancer
  • In case you want to configure the Notification node in your Load Balancer, it should not share the same URL with the Application nodes
  • Your team members can access to qTest Manager via the URL to the Application nodes as configured in the load balancer

Configure qTest Manager

Access to the Notification node to configure your qTest Manager instance and import license file following this instruction

  • If SSL is disabled: http://[notification_node_ip]:[WEB_PORT]
  • If SSL is enabled: https://[notification_node_ip]:[WEB_HTTPS_PORT]

Similarly, you will also need to import license file for each of the application nodes:

  • If SSL is disabled: http://[application_node_ip]:[WEB_PORT]
  • If SSL is enabled: https://[application_node_ip]:[WEB_HTTPS_PORT]