Summary: This section describes the upgrade process for the Back-end Node package on ALL Nodes.

  • There is no upgrade path between 1.x and 2.x. Instead see Upgrade path in Upgrade AIP Console.
  • The steps described in this guide:
    • need to be performed on all Nodes that are managed by Console.
    • are not required if you are using the Console Standalone deployment which includes one single Node together with Console.

Step 1 - Perform a backup

CAST highly recommends that you backup the Node data folder before proceeding - this is so that a roll back can be actioned if necessary. This is achieved simply by copying the folder to another unrelated location.

For ≥ 2.x, running an upgrade will overwrite the application.yml file that contains configuration settings. If you have modified this file, your customizations should be moved to the application-default.yml file which is never overwritten.

Step 2 - Run the JAR installer

Double click the executable .JAR file as provided with the installation media. If you are using OpenJDK, you may not be able to execute the .JAR file, instead use the following command to open the .JAR in GUI mode :

java -jar AIP-Console-<version>.jar

You can run the above command in the Command Prompt window (CMD) - ensure you launch the CMD window with elevated permissions (run as administrator).

The installation wizard will be displayed. If your existing installation is located in any of the locations listed below, then the wizard will detect them and the Upgrade an existing installation option will be selected automatically:

  • C:\Users\%USER_NAME%\CAST (Windows)
  • C:\%PROGRAMFILES%\CAST (Windows)

The Existing installation directory field will be auto populated with the existing installation location (you should ensure that this is the correct location). If the Install option is selected by default, this means that the installer is not able to detect an existing installation on the server - for example you installed it to a custom location. In this situation, you will need to manually select the Upgrade an existing installation option and enter the path to the existing installation in the Existing installation directory field.  Click Next to continue.

If the Console package is installed on a Microsoft Windows operating system, the following screen will then be displayed offering you the option to start up the relevant Windows Service when the upgrade is complete. Click Next to continue:

The update process will start. Click Next when complete:

The update process is complete. Click Done to close the wizard:

Step 3 - Restart Node

If you did not choose to restart Node during the upgrade, re-run the start shortcut or restart the the Windows service to restart the Node.

Step 4 - Check Node is present in Console

Browse to your Console URL http://<server>:8081/ui/index.html, login to Console with a user that has the ADMIN role and check that your Node(s) are visible and "up" using Administration Center - Nodes:

Also check that all Applications managed by the relevant Nodes are visible using Administration Center - Applications:

What next?

Now move on to the next step in the update process: CAST RESTAPI integrated upgrade.