Upgrade AIP Console


This section describes the upgrade process for the following components:

  • Front-end Console package
  • Back-end Node package on ALL Nodes
  • CAST-RESTAPI-integrated.war/zip/jar for embedded Dashboards

It is not possible to use Console and Node packages from different releases, therefore choosing to upgrade one of them necessarily means upgrading the other (i.e. upgrading the Console package AND all Node packages to the same release).

If you are using the Automation Tools available from https://github.com/CAST-Extend/com.castsoftware.aip.console.tools you MUST ensure that these are ALSO upgraded to the same release as the Front-end Console package and the Back-end Node package (in other words, Console/Node release must match the Automation Tools release. This process is beyond the scope of this documentation.

Upgrade path

2.x to 2.x

Upgrades to the latest release of 2.x are supported out of the box for Console/Node ≥ 2.0. This upgrade path is supported in this guide.

1.x to 2.x

It is not possible to upgrade direct from 1.x to 2.x. Instead the upgrade process requires a side-by-side approach:

  • Install a brand new deployment of Console/Node(s) 2.x on a brand new server where possible (CAST recommends installing the latest release of Console).
  • Use the Console V2 Migration Tool to clone your applications in the 1.x deployment into the 2.x deployment.

1.x to 1.x

Upgrades to the latest release of 1.x are supported out of the box for Console/Node ≥ 1.14. This upgrade path is supported in this guide. If you are using an older release and need to upgrade, please contact CAST Technical Support for assistance.

  • If you want to upgrade from a release between 1.14 and 1.17 (inclusive), you must perform a two step upgrade: first upgrade to 1.18, then from 1.18 to the latest release.
  • If you want to upgrade from ≥ 1.18 to the latest release, you can perform a direct upgrade to the latest release.

Information and prerequisites

(tick)Upgrade process for Console / Node packagesThe upgrade process is an "in place upgrade". This means that the existing installation locations (for Console and for the Node(s)) should be selected when the installer containing the new release of the Console/Node packages is run. The installer will detect that an existing install is present (in certain default locations) and will overwrite the existing installation with the new release, however, all configuration options from the previous release will be retained.
(tick)Embedded dashboardsIf you are using the CAST Dashboards embedded in Console, then CAST highly recommends that the CAST-RESTAPI-integrated.war file on your Apache Tomcat server is upgraded at the same time as the Console and Node packages. This file is shipped with every new release of Console. The upgrade process is a "side by side" 
(tick)Where to run the upgrade?

The upgrade must be run on the servers hosting the following:

  • Console
  • All Nodes managed by Console
  • Embedded Dashboards
(tick)Obtain and unzip the installation media

Download the latest release of Console from CAST Extend. This media contains:

  • a JAR file - the combined installer for both the Console and the Node packages.
  • a WAR/ZIP/JAR file - the integrated RESTAPI for embedded dashboards.

You will need to make a copy of the JAR/WAR/ZIP files on all servers that require an upgrade (do not run the JAR/WAR/ZIP files from a network share).

(tick)Stop all services

Before starting any upgrade process, you must ensure ALL services are stopped, for example stop Console and all Node packages by stopping the Windows Service or closing the CMD Window and stop the integrated RESTAPI.

(tick)Perform a backup

Before starting the upgrade, you may wish to perform a backup of your delivery/deploy/data folders. To do so, copy the relevant folders to an alternative location in case a roll back needs to be performed:

≥ 2.x
Custom shared network location for delivery/deploy/shared

A custom shared network location may alternatively be configured
(tick)Preserve custom settings (≥ 2.x)

If you have made changes to any application.yml files to modify configuration settings for front-end Console services or back-end Node services, running an upgrade will OVERWRITE this file, potentially removing any custom settings you have made. To preserve your custom settings there are two methods:

  • Transfer the custom settings to the application-default.yml / application-standalone.yml file located alongside the application.yml file (the application-default.yml / application-standalone.yml files are never overwritten). The settings in application-default.yml / application-standalone.yml will take priority over the settings in application.yml.
  • Or take a copy of the application.yml file and then transfer your custom settings to the new application-default.yml / application-standalone.yml file after the upgrade is complete.


Click to see the relevant instructions: