Upgrade guide

This page describes how to update the Squash components for the support of the automated tests.

Legend

️💎 indicates an Ultimate component or feature. An overview of the Premium and Ultimate features is available here. To benefit from these or to ask for more information, check our website or contact us.

Squash Orchestrator and Micro-services exclusive to Squash Ultimate💎

• Stop the orchestrator using opentf-done followed by the command used to stop the orchestrator (see Stopping the orchestrator).
  For example, if Squash Orchestrator is deployed using docker-compose:

  opentf-done --host http://localhost --token $TOKEN
  docker-compose down
  

• Update the Squash Orchestrator's Docker image.
• If you have the Ultimate version of Squash, update the Docker image, retrieved from the Squash support service, of the micro-services exclusive to Squash Ultimate💎.
• If the intermediate versions (between the pre-update version and the final version) or the final version itself require configuration changes, perform these. These instructions are indicated on the release notes page. If no instruction is indicated, no modification is to be made.
• Restart the Squash Orchestrator in the same way as before the update.
• If you have the Ultimate version of Squash, restart the services exclusive to Squash Ultimate in the same way as before the update.

Orchestrator tools

Update the Orchestrator tools by running the following command:

pip install --upgrade opentf-tools

OpenTestFactory Agent

• Stop the OpenTestFactory Agent.
• Update the agent by running the following command:

  pip install --upgrade opentf-agent
  

• Restart the agent.

Squash TM plugins

To update the Squash TM plugins, please refer to the installation protocol of a Squash TM plugin.

• Test Plan Retriever
• Result Publisher
• Squash AUTOM
• Git Connector
• Action Library
• Jira Automation Workflow