Manager 2024.1 to 2024.4 Single Server Upgrade Guide for Docker

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

Before You Begin

Read the following:

• Get started with qTest 2024.4 OnPremises

• Server Sizing Guide

To upgrade qTest Manager from a version older than 2024.1, please use our old Docker deployment packages.

Remove systemd service file

If your qTest Manager is set up as a Linux Daemon on this server, you should stop it first. If not, you can skip this step.

systemctl stop qtest

1. Access the directory where you've extracted the docker deployment package of qTest Manager 2024.4 (docker-deployment-4.16), shut it down and create a backup.

   $ ./shutdown
   $ ./backup
   $ ./uninstall

2. Download the Docker-Deployment-4.18 Package.

   This package supports the upgrade of qTest Manager from version 2024.1 to 2024.4.

   $ wget <ENTER DOWNLOAD LINK HERE>

3. Extract the package.

   $ tar -zxf docker-deployment-4.18.tar.gz

4. Access Docker-Deployment-4.18 Directory.

   $ cd docker-deployment-4.18

Configure qTest Manager

To keep all applications in your previous deployment from being upgraded, override the /profiles directory of docker-deployment-4.16 with the directory of docker-deployment-4.18.

$ cp -r /<path to your docker-deployment-4.16 package>/docker-deloyment-4.16/profiles/ /<path to your docker-deployment-4.18 package>/docker-deloyment-4.18/profiles/

Enhanced Security Option for Sessions and Insights

During an attempted CSRF attack, user credentials may potentially be inherited and then used to maliciously perform undesirable actions, usually affecting a change of state of server. Please note that this does not result in any data theft. SSL must be enabled.

Enter this command for Sessions:

$ ./configure --sessions-security-csrf-trusted-source-pattern "<qtest-manager-domain>[:port]|<qtest-sessions-domain>[:port]"

If you are configuring an external configuration, such as Jira, then the Jira URL should be whitelisted:

$ ./configure --sessions-security-csrf-trusted-source-pattern "<qtest-manager-domain>[:port]|<qtest-sessions-domain>[:port]|<jira-domain>"

For example:

$ ./configure --sessions-security-csrf-trusted-source-pattern "qtest-manager.com|sessions.com|jira.atlassian.net"

Enter this command for Insights:

$ ./configure --insights-security-csrf-trusted-source-pattern "<Whitelist domains>"

If you are configuring an external configuration, such as Confluence, then the Confluence URL should be whitelisted:

$ ./configure --insights-security-csrf-trusted-source-pattern "<qtest-manager-domain>[:port]|<qtest-insights-domain>[:port]|<confluence-domain>"

For example:

$ ./configure --insights-security-csrf-trusted-source-pattern "qtest-manager.com|insights.com|confluence.atlassian.net"

Deploy qTest Manager

1. Execute this command to initially set up and start the application.

   $ ./startup

   The script will download the application images and qTest components to the Docker. It may take a couple of hours depending on your network connection.

2. Open your web browser, and access qTest Manager using the URL specified above.

3. Validate if qTest Manager has started successfully.

4. Execute these commands to set up qTest Manager as a Linux Daemon.

   $ ./shutdown
   $ ./install

5. Start the service. You may need to wait for few minutes for qTest Manager to be available.

   $ systemctl start qtest