Page tree
Skip to end of metadata
Go to start of metadata

Summary: This section describes the upgrade process for the Front-end AIP Console package (which includes embedded Dashboards).

2.x - Docker install upgrade process

Updating existing images and containers is actioned in three steps using built-in Docker commands. There is no need to download the installation media and re-run it:

  1. Pull images associated with the services defined in the original docker-compose.yml file
  2. Build images defined in Docker files.
  3. Recreate containers with changed images.

To do so you need to run three docker commands, one after the other on your host:

docker compose pull
docker compose build
docker compose up -d

1.x - Upgrade process

Perform a backup

CAST highly recommends that you backup the AIP Console 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.

Run the JAR installer

Double click the executable .JAR file as provided with the installation media. If you are using OpenJDK or you are using a Linux environment, 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
  • In a Microsoft Windows environment, you can run the above command in the Command Prompt window (CMD) - ensure you launch the CMD window with elevated permissions (run as administrator).
  • In a Linux environment, you can run the above command in terminal.

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)
  • $HOME\CAST (Linux)

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 AIP 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. If AIP Console is installed as a Windows Service and you chose to start it on completion of the upgrade, the message Open AIP Console in browser will be ticked. Click Done to close the wizard:

Post upgrade actions

Restart AIP Console

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

Check access to AIP Console

Browse to your AIP Console URL http://<server>:8081/ui/index.html, login to AIP Console as you did previously and check:

  • that your configuration settings are correct (they should not have changed). New settings may also be visible.
  • that you are running the correct release of AIP Console using the login > About option:

Note that at this point no Application data will be visible in AIP Console since your AIP Nodes are currently stopped.

What next?

Now move on to the next step in the update process: AIP Node package upgrade.

  • No labels