In this article, we provide step-by-step instructions to upgrade qTest Insights 18.104.22.168 to qTest Insights 1.21.12 on a single CentOS/ Ubuntu machine using Docker. Please read the instructions thoroughly before starting your installations.
New for This Release: Insights Enhanced Security Enablement
Insights Enhanced Security Enablement
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
Before You Begin
- qTest Insights 1.21.12 only works with qTest Manager 9.8.1 or later.
Read the following:
Note: if you want to upgrade to qTest Insights 1.21.12 on the same machine with other applications, e.g. qTest Manager, on Docker environment, follow this article Manager 9.7.1 to 9.8.3 Single Server Upgrade Guide for Docker.
Upgrade qTest Insights
Shutdown and Backup your Current Deployment
- Open the Terminal.
- Access the directory where you've extracted the docker deployment package of qTest Insights 22.214.171.124, shut it down, and create a backup.
Download the Deployment Package
- Download docker-deployment-4.10 package.
$ wget <ENTER DOWNLOAD LINK HERE>
- Extract the package.
$ tar -zxf <DOWNLOADED PACKAGE FILE NAME>
- Access the docker-deployment-4.10 directory.
$ cd docker-deployment-4.10
Configure qTest Insights
Access to the directory where you've extracted the package, and run the ./configure command to deploy the package.
The command has to include URL & port of qTest Insights.
Configure to deploy HTTP
$ ./configure --insights-url "http://<IP of current machine>:<insights port>" --insights-http "<insights port>" --cluster "<IP address of qTest machine>"
Configure to deploy HTTPS
$ ./configure --ssl-key "<SSL Key>" --ssl-cert "<SSL Cert>" --ssl-ca "<SSL Ca>" --insight
Enhanced Security Whitelist Example:
- qtest Manager domain: https://manager.qtest.com
- qtest Insights domain:
- You use a Confluence page to embed reports/dashboard, shareable URL dashboard, rapid dashboard: https://confluence.qtest.com
- Whitelist domain: manager.qtest.com|insights.qtest.com|confluence.qtest.com or qtest.com
Configure to deploy with the Enhanced Security
$ ./configure --insights-security-csrf-trusted-source-pattern "<Whitelist domains>"
If you are configuring an external configuration, e.g 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>"
$ ./configure --insights-security-csrf-trusted-source-pattern "qtest-manager.com|insights.com|confluence.atlassian.net"
Start the Deployment Process
- Start the deployment process by executing a startup script which will download application images and qTest Insights components to the Docker container.
Note: It may take a while to complete depending on your network connection.
- When it's done, you can access qTest Insights and verify the new version.