In-place component update for Cloud services via Kubernetes

Overview

This guide provides instructions for running an in-place update to a new release of CAST Imaging i.e. using the Helm Chart scripts provided in com.castsoftware.castimaging-v3.kubernetessetup external link:

  • on one single machine
  • or via a distributed deployment (multiple machines)

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

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

Supported update paths

Source Target Supported? Notes
3.2.2-funcrel / 3.2.3-funcrel 3.3.0-funcrel ✅ -
3.2.2-funcrel 3.2.3-funcrel ✅ -
3.1.0-funcrel 3.2.2-funcrel / 3.2.3-funcrel ❌ Not supported - a fresh installation of the target release is required.
3.0.0-funcrel 3.1.0-funcrel ❌ Not supported - a fresh installation of the target release is required.

Requirements

  • Local administrator privileges (user in the sudoers list / ability to Run as administrator)
  • All existing containers should be left running during the update (the update script will stop and restart them automatically)
  • Sufficient local disk space for the new images
  • A previous CAST Imaging installation should exist on the target machines
  • 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)

Update process

Step 1 - Clone target release branch

Clone the target release Git repository branch (i.e. matching the release of CAST Imaging you want to update to) of com.castsoftware.castimaging-v3.kubernetessetup external link. For example to clone the 3.3.0-funcrel release branch use:

git clone -b 3.3.0 https://github.com/CAST-Extend/com.castsoftware.castimaging-v3.kubernetessetup

Step 2 - Update *.yaml files

Update any *.yaml files in the newly cloned branch with the exact same values as used in the currently deployed release of CAST Imaging, e.g.:

  • values.yaml
  • templates/console-authenticationservice-configmap.yaml

Step 3 - Run the update

Run the Helm update script:

helm upgrade castimaging-v3 --namespace castimaging-v3

Step 4 - Verify update success

  • Verify services in the CAST Imaging admin panel:
    • Navigate to the Services settings page
    • Confirm all services show green status indicators:

Next steps

If you need to update applications to a new release of CAST Imaging Core (if provided), see In-place core and application update.