In-place component update

Overview

This guide provides instructions for running an in-place update to a new release for the following installed items:

• Microsoft Windows deployment of com.castsoftware.imaging.console : on one single machine or via a distributed deployment
• Linux via Docker deployment of com.castsoftware.imaging.all.docker : on one single machine or via a distributed deployment

This process will update the following installed components and retain all existing data (applications, results, etc.):

• imaging-services
• imaging-viewer
• analysis-node

Supported update paths

Requirements

• Local administrator privileges:
  • Microsoft Windows: ability to Run as administrator
  • Linux via Docker: user in the sudoers list
• For Microsoft Windows, all existing services should be left running during the update.
• For Linux for Docker, CAST recommends stopping the containers before pulling new images.
• In a distributed deployment scenario:
  • all components MUST be updated to the same new release (i.e. you cannot update just the analysis-node component or just the imaging-services component)
  • you can update components in any order i.e. the analysis-node component can be updated before imaging-services or imaging-viewer component
• It is not possible to change the TCP port number of any service, nor any HOSTNAME_xxx installation variables as part of the update process.

For Microsoft Windows, CAST recommends disabling Quick Edit mode in your command (CMD) window before running the update. This mode (if enabled) will pause the batch script if there is any interaction with the command window (e.g. a mouse click) during the process and will not re-start the script until a key is pressed:

Microsoft Windows deployment

Download the latest release of the installer  and unzip it anywhere on your local disk. You will need to download/unzip the installation media on each machine where a component is to be updated. Locate the relevant *.conf file at the root of the unzipped files and open with a text editor. For example:

• single machine installation: edit the config-all.conf file.
• distributed installation: edit the config-imaging-services.conf, config-imaging-viewer.conf or config-analysis-node.conf file to match the component installed on the current machine

Modify the appropriate configuration file to ensure that all parameters EXACTLY match those that were used in the same file when installing the previous release. You can find an explanation of the parameters in Microsoft Windows installation variables.

To run the in-place update, on the appropriate machine open a CMD window with elevated permissions (right click, Run as administrator) and execute the appropriate command from the root of the unzipped files, depending on the component(s) you are updating:

• Single machine
• Distributed deployment

  cast-imaging-update.bat package=all

  cast-imaging-update.bat package=imaging-services
  cast-imaging-update.bat package=imaging-viewer
  cast-imaging-update.bat package=analysis-node

The update process will then proceed. All existing data will be preserved. On completion you should check that:

• all Microsoft Windows services are up and running (the screenshot below is for a single machine installation):

• all services within the CAST Imaging Services “admin” panel are showing in green:

Linux via Docker deployment