Scenario 2023.5 to 2024.1 and Pulse 2024.1 to 2024.4 Upgrade Guide for Docker

In this article, we provide step-by-step instructions to upgrade qTest Scenario from 2023.5 to 2024.1 on a single RHEL/Ubuntu machine using Docker. Please read the instructions thoroughly before starting your installations or upgrades.

Complete the OnPremises Technical Services Request form (opens in new tab) to request assistance or obtain self-installation links, whether you're upgrading or performing a fresh install.

If you are upgrading qTest, it is highly recommended that you clear your qTest browser cache after receiving qTest 2024.4.
  • Windows: Ctrl+F5

  • Mac/Apple: Apple+R or Command+R

  • Linux: F5

Before You Begin

Read the following:

If you want to upgrade to qTest Scenario 2024.1 and Pulse 2024.4 on the same machine with other applications, e.g. qTest Manager, on Docker environment, refer to Manager 2024.1 to 2024.4 Single Server Upgrade Guide for Docker.

Shutdown your Previous Deployment

  1. Open Terminal.

  2. Access the directory where you extracted the previous docker deployment package 4.16, shut it down and create a backup.

    $ ./shutdown
    $ ./backup

Download Deployment Package

  1. Download docker-deployment-4.18 package.

    $ wget <ENTER DOWNLOAD LINK HERE>
  2. Extract the package.

    $ tar -zxf <DOWNLOADED PACKAGE FILE NAME>
  3. Access the docker-deployment-4.18 directory.

    $ cd docker-deployment-4.18

Configure qTest Scenario

Copy the configuration of all applications in your previous docker deployment to the /profiles directory of docker-deployment-4.18 package.

$ cp -r /path/to/docker-deloyment-4.18/profiles/ .
  • The above command will copy the old configuration file at /docker-deployment-4.16/profiles/default.in to /docker-deployment-4.18/profiles/default.in

  • Next, open the file at /path/to/docker-deployment-4.16/profiles/default.in, locate and change the version value to 4.18, as below:

    version = "4.18"

Start Deployment Process

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

$ ./startup

Update File to Reflect 2024.4

  1. Open file `.../docker-deployment-4.18/app.config.in`

  2. Find the line "pulse_version='2024.1'" and change "2024.1" to "2024.4" for that line and the line below (two occurrences).

  3. Restart qTest service.

Confirmation

To make sure the patch has been applied successfully, you can check the version number at the bottom of Pulse's web UI.

Troubleshooting

If the steps above are not successful, perform the following steps to rollback to qTest Scenario 2023.5 and Pulse 2024.1 (docker, images, scenario, pulse).

Restore backup data:

# cd /path/to/docker-deployment-4.16
# ./restore

Start qTest Scenario 2023.5 and Pulse 2024.1.

# ./startup

When the restore process is complete, contact Customer Support to troubleshoot the issue with upgrading qTest Scenario.