In this article, we provide step-by-step instructions to upgrade qTest components from 9.7.1 to 9.8.3 OnPremise on a single CentOS/Ubuntu machine. Please read the instructions thoroughly before starting your upgrade.
New for This Release: Enhanced Security Enablement 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. Additional details are provided below.
About the Command Line Wizard
The qTest 9.8.3 Command Line Wizard is a command line interface application that allows you to configure basic settings for qTest applications in your purchased package.
You should understand these Command Line Wizard characteristics before you begin:
- For each step, the installer will prompt you for a specific input value. After you provide a value, the installer will validate the input. If the value is incorrect, or additional permissions are required, an explicit error message displays so it’s easy to know how the input value should be corrected.
- Default values display in square brackets [ ]. To use the default value, simply hit the Enter key.
- Input values for yes/no questions, should be 'y', 'yes','n', 'no' (ignore case sensitive.) Any value other than those listed will be treated as a 'no.'
- To terminate the configuration at any time without completing it, press Ctrl+C.
Hint: In the event you cannot start the Command Line Wizard again after terminating the configuration, backup then remove the qtest.config file. Retry to start the Command Line Wizard again.
- The Command Line Wizard and qtestctl do not support the character "$". Therefore, a password, username, or any other value that you would enter in a prompt should not contain "$."
- qtestctl does not support special characters "#" or "?" in your PostgreSQL password
Before You Begin
Read the following:
- Getting Started with Q4 2019 OnPremise
- Q4 2019 OnPremise Prerequisite Software for Linux
- Recommended Hardware Requirements
- Backup your Data before you upgrade.
Please note that the Command Line Wizard will prompt you for each installation instruction. You will need to perform action items and gather specific connection information before you begin the upgrade process.
IMPORTANT: You will use the same configurations as in your 9.7.1 qtest.config file and can copy those to your new deployment package so they will be your default values in the 9.8.3 Command Line Wizard.
If you need to change your previous configurations, please review the application checklist provided here so you can see what information you will need.
Make sure the appropriate Ports for the prerequisite applications and qTest applications are open prior to any self/assisted upgrade. You should only open the HTTPS ports if you plan to serve SSL from the application.
LINUX NON-DOCKER AND WINDOWS
|Product||HTTP Port||HTTPS Port|
IMPORTANT: Suggested application ports are listed above, however, you are allowed to use a port of your choosing for the qTest applications you install.
Stop qTest Applications
- Access your qTest Manager server.
- Log in as root user on your command shell.
- Access the installation directory of Manager 9.7.1.
- Execute the command below to stop qTest applications.
# systemctl stop qtest
- Remove the qTest service.
Backup qTest Manager, Sessions, and Parameters
- Backup your databases following these instructions.
Download and Start the Installation Package
- Request the installation files through the OnPremise Upgrade Form which is also available at the top of this article.
- Once the OnPremise Upgrade Form is completed and submitted, the download link will be emailed to you from our Implementation Team.
- Access the qTest server.
- Log in as a root user on your command shell.
- Download and extract the zip file to a folder on disc.
- Navigate to the extracted folder at \path\to\qtestctl\
- Access the 6.4 deployment folder and copy the qtest.config file from your prior deployment to your new 6.5 deployment package. This will copy your previous values and set them as the displayed default values in the Command Line Wizard.
- Run the following command to start the installation:
Note: A default value is provided for each prompt in the square brackets. If you copied your qtest.config file from your previous deployment to your new deployment package, then your previous configurations will be the default values displayed. You can press Enter to use your default values, or input new values and then press Enter.
Choose the Applications to Upgrade
Provide a Yes (y) or No (n) response to the following question. Your response provided here will determine which components are upgraded on this Windows machine.
- qTest Manager [Y] or [N]
- qTest Sessions [Y] or [N]
- qTest Parameters [Y] or [N]
- qTest Insights [Y] or [N]
- qTest Launch [Y] or [N]
- qTest Pulse [Y] or [N]
- qTest Scenario [Y] or [N]
Configure Prerequisite Applications
Configure PostgreSQL Database
Review your PostgreSQL Database information you copied from your previous deployment. If you need to enter new values you may do so. You will only need to configure PostgreSQL if you have selected at least one of the following applications:
NOTE: 9.8.3 includes a Postgres SSL enablement option. Make sure to read this section in the prerequisite article to ensure you are ready for this step before proceeding.
Configure ElasticSearch Database
This must also be enabled if you are planning to use the Enhanced Security Option listed below.
If you do not want to deploy with SSL, type "n" for the Enable secured connection (Y/N) [N]: and move to configure the qTest applications.
If you do want to deploy with SSL, type "y" for the Enable secured connection (Y/N) [N]: and input the path to cert and key files :
- cert: absolute path to the certificate file on this server. Please use / in the path, recommend copying the path from system file browser.
- key: absolute path to the private key file on this server. Please use / in the path, recommend copying the path from system file browser.
- passphrase: input passphrase if your key has passphrase
Configure qTest Applications
The following applications will be configured using the information you copied from your previous deployment package. The prompt will ask for configuration details based on the applications you chose to upgrade in Step 1.
Example: If you chose to upgrade one application in Step 1, then you will only supply configurations to the Command Line Wizard for that one application on this machine.
If you want to store resource files on a local disk enter "1" or "disk_storage" and input the storage location. The location should be an absolute path to the folder. Please use / in the path, recommend copying the path from system file browser.
If you want to store resource files on Amazon s3 enter "2" or "amazon_s3" and input s3 access key, s3 secret key and bucket name:
Note: if you choose to use Amazon S3 as qTest Sessions storage by selecting amazon_s3 for storage type. Refer to this article to learn how to setup Amazon S3 bucket as well to manage access permission.
Enhanced Security Option
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.
- qTest Managers HTTP or HTTPS Port
- URL to access qTest Manager outside of this machine
- qTest Sessions HTTP or HTTPS Port
- URL to access qTest Sessions outside of this machine
- External Defect Tracker domain
For Insights 1.21.9, if you chose to specify a directory to store your saved reports and dashboards and this directory can be accessed from Insights 1.21.9 and 1.21.12 (ex: D:\data\insdata, as this directory, is completely independent of the Insights qtestctl 1.21.9 and 1.21.12 directory.)
Then to upgrade Insights to 1.21.12, at the command "Specify the directory to store saved reports and dashboards [Function.AppPhysicalPath]" input the suitable path (ex: D:\data\insdata) of the directory used to store your Insights 1.21.9 data.
Insights Enhanced Security Option
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.
3 Insights features are impacted by this new security configuration:
- embed reports/dashboard
- shareable URL dashboard
- rapid dashboard
Insights allow users to generate an HTML template and embed it into an external website ex: Confluence. Therefore, the domain of this website need to be included in the Whitelist domain. SSL must be enabled.
- qTest Managers HTTP or HTTPS Port
- URL to access qTest Manager outside of this machine
- qTest Insights HTTP or HTTPS Port
- URL to access qTest Insights outside of this machine
- External Reporting domain i.e. Confluence
Review the Configuration
After all the configurations are entered, they are stored in qtest.config file. You can open the file to review the configuration details.
- If you need to modify a value, you can re-run the wizard (recommended) or modify the qtest.config file.
- To restore the default configurations, delete qtest.config and re-run the wizard.
Start the Deployment
To start the deployment, execute this command:
# ./qtestctl --offline start
The command will take control of the terminal. Keep it running.
You will receive a Build Successful message once the upgrade is complete.
Configure qTest Manager to Connect to qTest Applications
Follow this article to configure qTest Manager to connect with the other qTest applications you installed. You should also verify that the applications can be accessed and working properly before performing the next and final step.
Stop the Running Process
Navigate back to the Command Prompt and stop the running process (Ctrl + C).
Install qTest Applications as a Service
We highly recommend you enable qTest applications to automatically start on system startup. For more information on installing qtest service, read the qtestctl as a Service article.
- In the Command Prompt, press `Ctrl + C` if qtestctl is running.
- Navigate to the folder
- Execute the command below to install the new qTest Sessions service.
- You have now finished upgrading qTest applications.
- Access to qTest Sessions and verify the new version.
Migrate Data from Insights 1.21.9 to Insights 1.21.12
Stop Insights 1.21.9 before performing your data migration.
[path_to_NEW_qtestctl]> systemctl stop qtest
- Navigate to the Root folder of Insights 1.21.9:
- If using the default directory (Function.AppPhysicalPath) to store saved reports and dashboards in Insights 1.21.9 then use this root folder: \qtestctl\insights\build\tomcat\webapps\ROOT
- If using a directory that can be accessed from Insights 1.21.9 and 1.21.12 (ex: D:\data\insdata) then navigate to that root folder.
- Copy the following folders:
- Move the copied folders to a new location for Insights 1.21.12 at:
- If using the default directory (Function.AppPhysicalPath) to store saved reports and dashboards in the qTest Insights configuration above, then paste to \qtestctl\insights\build\tomcat\webapps\ROOT
- Otherwise, paste to the directory (ex: D:\data\insdata) you specified in the qTest Insights configuration above.
Import qTest License
After the upgrade, you will need to manually copy the qTest License file from Manager 9.7.1 and then import it to 9.8.3. (These instructions are also covered in the Configure Manager article linked above.)
- Access your qTest Manager instance via your browser using the URL as specified in the qtest.config file.
- You will be redirected to the Licenses - Users tab in the Site Administration panel.
- Select the Import License File button.
- Browse to your license file located under the installation directory for qTest Manager v9.7.1:
- Your license file will import into qTest Manager 9.8.3.