Sessions 4.0.2 Load Balancing Upgrade Guide for Docker

To request assistance with upgrading or to obtain the links to self-upgrade, please click here to fill out the Upgrade Request Form.

In this guide we'll run you through upgrading qTest Sessions from 3.0.9 to 4.0.2 on a Load Balancing environment where multiple instances of qTest Sessions are installed and each one is running on a separated CentOS/Ubuntu server using Docker.

Before you begin 

  • qTest Sessions 3.0.9 was delivered with docker deployment package 4.0 and qTest Sessions 4.0.2 is delivered with docker deployment package 4.3
  • You will need docker-deployment-4.3 package to perform the upgrade
  • qTest Sessions 4.0.2 works with qTest Manager 8.7 and later. So make sure qTest Manager has been installed and running


You have already installed earlier version qTest Sessions on Load Balancing environment using Docker, and the running version of qTest Sessions is 3.0.9.

Below is a specific scenario of installing qTest Sessions on Load Balancing environment using Docker. Highlighted items are qTest Sessions and components it needs to run. This article will cover:

  • Upgrading qTest Sessions application nodes, which are Machine #2 and Machine #3.


Upgrade qTest Sessions

This article guide you to upgrade qTest Sessions on one machine, e.g. Machine 2. You will repeat the same upgrading steps on another machine, e.g. Machine 3, as shown in the sample diagram to fully upgrade qTest Sessions on Load Balancing environment.

Let's access to qTest Sessions server (Machine 2) and start our upgrading process.

1. Shutdown your previous deployment

1.1 Open Terminal.

1.2 Access to the directory where you've extracted the previous docker deployment package 4.0, shut it down and create a backup.

$ ./shutdown
$ ./backup

2. Download deployment package

2.1 Download docker deployment 4.3 package


2.2 Extract the package


2.3 Access to extracted package directory

$ cd docker-deployment-4.3

3. Configure qTest Sessions

Choose one of the below options to configure qTest Sessions:

Option 1: copy configuration of all applications in your previous deployment to the /profiles directory of docker-deployment-4.3 package.

$ cp -r /path/to/docker-deloyment-4.0/profiles/ .

Above command will copy the old configuration file /docker-deployment-4.0/profiles/ to /docker-deployment-4.3/profiles/

Next, open the file at /path/to/docker-deployment-4.3/profiles/, locate and change the version value to 4.3, as below:

version = "4.3"

Option 2: use ./configure command and specify sessions application that you want to configure.


$ ./configure --sessions-url "http://<IP of current machine>:<qTest Sessions port>" --sessions-http "<qTest Sessions port>"


$ ./configure --ssl-key "<SSL Key>" --ssl-cert "<SSL Cert>" --ssl-ca "<SSL Ca>" --sessions-url "https://<IP of current machine>:<qTest Sessions https port>" --sessions-https "<qTest Sessions https port>"

4. Upgrade qTest Sessions

Execute command below to upgrade qTest Sessions.

$ ./upgrade

5. Start deployment process

Next, start deployment process by executing startup script to download the application images and qTest Sessions components to the Docker container. It may take a while to complete depending on your network connection

$ ./startup

6. Upgrade qTest Sessions on Machine 3

Access to Machine 3 where qTest Sessions has been installed

Repeat step 1 to step 5 to upgrade qTest Sessions to 4.0.2

7. Machine 4 (sessionslb - the load balancer)

Access to the directory where you've extracted the docker deployment package 4.0, shut it down then start it up using following commands.

$ ./shutdown
$ ./startup

You probably realized that, for sessionslb, it is optional to upgrade the docker deployment package to 4.3 and keep the earlier version 4.0. However, if you want to upgrade sessionslb to 4.3 for consistency, you can repeat step #1 to #5 on Machine #4 just like you did with Machine #2 and Machine #3.

8. Troubleshooting

If any of steps above are not successful, you need to rollback to qTest Sessions 3.0.9 (including docker, images, sessions, sessionslb on machine #2, #3, #4) following below steps.

8.1 Access to each machine

8.2 Restore backup data by accessing to the earlier docker deployment folder and running backup command

$ cd /path/to/docker-deployment-4.0
$ ./restore
$ ./startup

When restore process is done, perform the following steps to completely rollback data of qTest Sessions 3.0.9

  • Open <qTest Sessions URL:port>/admin page. Here <qTest Sessions URL:port> is the URL to access to your  qTest Sessions 3.0.9
  • Login with your admin account. Note: consult QASymphony Customer support for the admin credentials.
  • Go to elasticsearch menu item in the left panel
  • Click on 'Reindex Data' button

After that, contact QASymphony customer support to troubleshoot the issue with upgrading qTest Sessions.




Subscribe To Our Blog
Powered by Zendesk