3.0 qTest Scenario On-premise Installation (New)

Windows Installation

  1. Download & install VirtualBox, if it is not available in your machine
  2. Download & run this qTest Scenario OVA image
  3. Start the qTest Scenario virtual machine, if it doesn't start automatically
  4. Login to the console with the following credentials
    Username: ubuntu
    Password: scenario
  5. Run passwd to update the password, please keep it carefully since we cannot recover in case of lost
    $ passwd
  6. Access to the deployment directory
    $ cd docker-deployment-2.1
  7. Configure the bundle
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="[scenario url]" --scenario-http="[scenario port]"
    Eg:
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="http://192.168.75.134" --scenario-http="80"
    In case of using https:
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="[scenario url]" --scenario-https="[scenario https port]" --ssl-key="[path key]" --ssl-cert="[path cert]" --ssl-ca="[sign cert]"
    Eg:
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="https://192.168.75.134" --scenario-https="443" --ssl-key="/etc/pki/tls/private/mydomain.key.pem" --ssl-cert="/etc/pki/tls/private/mydomain.crt.pem" --ssl-ca="/etc/pki/tls/private/ca.crt.pem"
  8. Startup the application
    $ ./startup
  9. In VirtualBox, configure the port forwarding from host to virtual server
    VB Network Settings
    VB Port Forwarding
    VB Add Port
    The Host Port is an avaible port in the host server, while the Guest Port is the port we have configured in scenario-http (or scenario-https) parameter above. So the application now can be accessed via http(s)://[Host IP]:[Host Port]
  10. After the deployment process completes, please access to Jira Server to configure the Scenario plugin following this instruction

Linux Installation

Prerequisites

  1. Docker Host version 1.6+ has been installed on the machine.
    • For CentOS 7.X+ or Ubuntu 14.04+ machines: Docker requires a 64-bit installation and your kernel must be at least 3.10
    • Please follow these instructions to install Docker on your machine
  2. Docker Client has been installed. You will need to execute the deployment shell scripts in this instruction using the tool
  3. Docker Host is accessible using Docker Host

Installation

  1. Access to your machine where Docker Client has been installed using a user which has been added to docker user group
  2. Download the Docker Deployment Package, extract it and access to extracted directory
    $ wget https://s3.amazonaws.com/qtest-storage/docker/deployment/docker-deployment-2.1.tar.gz
    
    $ tar -zxf docker-deployment-2.1.tar.gz
    $ cd deployment-2.1
  3. Configure the bundle
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="[scenario url]" --scenario-http="[scenario port]"
    Eg:
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="http://192.168.75.134" --scenario-http="80"
    In case of using https:
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="[scenario url]" --scenario-https="[scenario https port]" --ssl-key="[path key]" --ssl-cert="[path cert]" --ssl-ca="[sign cert]"
    Eg:
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="https://192.168.75.134" --scenario-https="443" --ssl-key="/etc/pki/tls/private/mydomain.key.pem" --ssl-cert="/etc/pki/tls/private/mydomain.crt.pem" --ssl-ca="/etc/pki/tls/private/ca.crt.pem"
  4. Start the deployment process
    ./startup
  5. The script will download the application images and Scenario components to the Docker Host. It may take couple of hours depending on your network connection.
  6. After the deployment process completes, please access to Jira Server to configure the Scenario plugin following this instruction

Configure Jira Server Plugin

  1. Find the qTest Scenario Add-on in Manage Add-on page
    Manage Add-on
  2. Open & configure the add-on
    Manage Configure Plugin
  3. Input the qTest Scenario Server URL, select a Jira user then save
    Configure Plugin
    For using the Scenario Cloud instead of Scenario Server, users can input services.qtestscenario.com; http or https depends on the Jira server. The selected user here will be used by Scenario when creating/updating Jira objects.

Miscellaneous & Troubleshooting

Check network ports

For Windows

You can check for which ports are being used by the following steps.
    1. Open a command prompt window (as Administrator): From "StartSearch box", enter resmon.exe
    2. On tab Network, expand Listening ports
Miscellaneous and Troubleshooting - Resource Monitor

For Linux

You can check for which ports are being used by the following command:
# netstat -npult 

Reconfigure Deployed Components

    1. Access the directory where the deployment scripts are located & shut down the applications:
$ cd docker-deployment-2.1 
$ ./shutdown 
$ ./weave stop 
  1. Execute configure command and pass in the parameters to change the configurations. Eg:
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="http://192.168.75.134" --scenario-http="80"
    $ ./configure --apps="postgres scenario scenariolb" --scenario-url="https://192.168.75.134" --scenario-https="443" --ssl-key="/etc/pki/tls/private/mydomain.key.pem" --ssl-cert="/etc/pki/tls/private/mydomain.crt.pem" --ssl-ca="/etc/pki/tls/private/ca.crt.pem"
  2. Then starup again
    $ ./startup 

Backup

  1. Shutdown Scenario
    $ cd docker-deployment-2.1
    $ ./shutdown 
  2. Run the following command to create a backup file in the Docker Host
    $ ./backup 
    It will backup qTest on Docker host and save it as yyyy-mm-dd.tar.gz, in which yyyy-mm-dd is the date when the backup file was created.
  3. In case you want to backup and then download the backup file from the Docker host to your local machine, run this command
    $ ./backup pull 
    It will download yyyy-mm-dd.tar.gz, in which yyyy-mm-dd is the date when the backup file was created, to your current directory.

Restore

  1. Run this command
    $ cd docker-deployment-2.1yyyy-mm-dd 
    $ ./restore yyyy-mm-dd 
    • You can use yyyy-mm-dd to restore from a specific date when the backup file was created
    • If yyyy-mm-dd is omitted in the command, the most recent backup file will be restored by default
  2. If you want to restore from a backup file which was downloaded to your local machine, run this command and pass in the file path
    $ ./restore [path to yyyy-mm-dd.tar.gz]