Menu

Prerequisite Software for qTest OnPremise Spring 2019 for Windows

Overview

Use this article to install and configure prerequisite applications before you install qTest 9.5.3 OnPremise (Spring 2019 release) on a Windows machine. These prerequisite applications apply both to a single server or load balancing server.

There are 3 required prerequisites:

  • PostgreSQL - 9.5.4 to 9.6.6
    • PostgreSQL 10 is NOT certified for this release. 
  • Elasticsearch - 6.3 to 6.6
  • MongoDB - 3.4 to 3.6 (needed for Scenario and Pulse)

Important: We provide a range of supported versions for the prerequisite components so that OnPremise customers can easily maintain qTest OnPremise over time. This reduces the need for you to upgrade every prerequisite component each time you upgrade qTest to the most recent version.

Ports

Please note, that you must open the ports below prior to any self/assisted installation or upgrade.

PREREQUISITE APPLICATIONS

Product  Port
Postgres 5432
ElasticSearch 9200
Network Drive 2049
MongoDB 27017

 

PostgreSQL 

Please note, that the example installation below, provides the recommended install version. However, you can use a prerequisite version different than these examples as long as the prerequisite version falls within the range of supported versions listed above.
IMPORTANT: PostgreSQL 10 is NOT certified for this release.

Install PostgreSQL 

Follow the Postgres website for installation instructions.

IMPORTANT: Ensure that the Postgres user has the following permissions: read, write, create/delete/modify tables/schema/functions/sequences/triggers/views

Configure PostgreSQL 

Once PostgreSQL is installed, follow steps below to enable remote access to PostgreSQL database server:

  1. Open file C:\Program Files\PostgreSQL\9.5\data\pg_hba.conf.
  2. Edit the file and append the following line to specify the IP of the server which will remotely connect to your PostgreSQL.
    Example:host all all [IP_Address] md5
    • This should be the server where qTest packages are installed.
      • If you want to allow connection from multiple client machines on a specific network, specify the network address here in the CIDR-address format.
      • If you want your PostgreSQL to accept all incoming connections regardless of the source IP address, use 0.0.0.0/0 as the IP address.
  3. Open file C:\Program Files\PostgreSQL\9.5\data\postgresql.conf. Append the following line:
    Example: listen_addresses = '*'

Create qTest Database in PostgreSQL Server

This step is to create a database name which will be used when you configure qTest Manager.

There are different ways to create a database in PostgreSQL, which we provide one of those ways below.

For Windows, you can use pgAdmin which is installed together with your PostgreSQL server.

  1. Open pgAdmin.
  2. Enter your username and password to connect to your PostgreSQL server
  3. On the left panel, right-click on the Databases folder and select New Database...
  4. Enter your database name and select OK.
  5. Take note of the database name, as you will use it when entering values in the Command Line Wizard.

Restart PostgreSQL

Run the following command to restart PostgreSQL:
net stop postgresql-x64-9.5 && net start postgresql-x64-9.5

ElasticSearch

Please note, that the example installation below, provides the recommended install version. However, you can use a prerequisite version different than these examples as long as the prerequisite version falls within the range of supported versions listed above.

Install ElasticSearch

  1. Install Java JDK 1.8 prior to installing ElasticSearch.
  2. Download the .zip file from:
    https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-6.6.0.zip
  3. Unzip the downloaded file. This will create a folder named elasticsearch-6.6.0, which will be referred to as:
     %ES_HOME%
    install_elasticsearch.png

Configure ElasticSearch

  1. Open file %ES_HOME%\config\elasticsearch.yml, and add the following line to the end of the file, to allow connections from outside of the ElasticSearch server.
    network.host: 0.0.0.0
  2. By default, ElasticSearch will use port 9200. If you would like to change the default port, open file %ES_HOME%\config\elasticsearch.yml and change the port number by adding a new configuration line, for example:
    http.port: 9201
    Note: Please make sure that you select an available port in the server and open the port to allow inbound connections.
    elasticsearch_port_info.png

Run ElasticSearch as a Windows Service

  1. Open the Command prompt and navigate to %ES_HOME%\bin
    cd D:\elasticsearch-6.6.0\bin
  2. Install Elasticsearch as a service on your Windows machine.
    elasticsearch-service.bat install
  3. Start ElasticSearch service.
    elasticsearch-service.bat start

Please refer to the official installation instructions of ElasticSearch for further information.

MongoDB

Please note, that the example installation below, provide the recommended install version. However, you can use a prerequisite version different than these examples as long as the prerequisite version falls within the range of supported versions listed above.

Install MongoDB

qTest Scenario and Pulse require you to install MongoDB within this version range 3.4-3.6.

  1. Install MongoDB 3.4.
    Hint: Keep a record of the designated username and password used for root user creation.
  2. After the download is complete, double-click the MongoDB 3.4 file and follow the installation wizard to install.
  3. When the installation completes, make sure MongoDB’s bin folder is added to the System Environment Variables.

mongo-env-vars.png

Configure MongoDB

MongoDB requires a data directory to store all data.

  1. Create the data directory folder by running the following command in a Command Prompt:
    md [PATH\TO\DB\FOLDER]
    Example:
    md C:\data\db
  2. Start MongoDB as an Administrator with the following command:
    mongod --dbpath [PATH\TO\DB\FOLDER] --replSet "rs0"
    Note: if your path includes spaces, enclose the entire path with double quotes.

    start-mongod.png

Create Root User

  1. Open a second Command Prompt as an Administrator and execute the below command to create a root user:

    mongo
    rs.initiate()
    rs.status()
    use admin
    db.createUser ({
        user: "[USER_NAME]",
        pwd: "[PASSWORD]",
        roles: ["root"]
    })

    Example:

    mongo
    rs.initiate()
    rs.status()
    use admin
    db.createUser ({
        user: "tdm",
        pwd: "password",
        roles: ["root"]
    })

    mongo-create-user.png
  2. Close both Command Prompt windows.

Run MongoDB as a Windows Service

  1. Open a new Command Prompt as an Administrator.
  2. Create a folder for log files:
    md [PATH\TO\LOG\FOLDER]
    Example:
    md C:\data\log
  3. Create a configuration file at MongoDB installation folder:
    Example:
    C:\Program Files\MongoDB\Server\3.4\mongod.cfg.

    mongod-cfg.png

  4. Open your favorite text editor as an Administrator and edit the file as follows:
    systemLog:
      destination: file
      path: [PATH\TO\LOG\FOLDER]
    storage:
      dbPath: [PATH\TO\DB\FOLDER]
    replication:
      replSetName: rs0
    security:
      authorization: enabled
    

    Example:

    systemLog:
      destination: file
      path: C:\data\log\mongod.log
    storage:
      dbPath: C:\data\db
    replication:
      replSetName: rs0
    security:
      authorization: enabled
    mongod-cfg-editor.png
  5. Create the MongoDB service by running the following command:
    "C:\Program Files\MongoDB\Server\3.6\bin\mongod.exe" --replSet "rs0" --dbpath "C:\data\db" --logpath "C:\data\logs\mongod.log" --install --serviceName "MongoDB"
    Example if using a config:
    "C:\Program Files\MongoDB\Server\3.6\bin\mongod.exe" --config "C:\Program Files\MongoDB\Server\3.6\mongod.cfg" --install
    create-mongo-service.png
  6. Start the MongoDB service by running the following command as an Administrator:
    net start MongoDB
    start-mongo-service.pngNotes:
    • If you would like to stop the MongoDB service, run the following command:
      net stop MongoDB
    • If you would like to remove the MongoDB service as needed, first stop the service and then run the following command:
      sc.exe delete MongoDB
  7. Verify that MongoDB service is running by following the steps below:
    • Open the Command Prompt as an Administrator and type services.msc to open the Services window.
    • On the Services window, look for the service named MongoDB and make sure the Status is Running and the Startup Type is set to Automatic, as shown below.

mongodb-service.png

Powered by Zendesk