|Summary: step-by-step instructions for your back-end AIP Node installation.|
You will need to run the AIP Console installer on each AIP Node (i.e. a machine on which AIP Core is already installed) that you want to manage with AIP Console.
To run the setup, local Administrator privileges are required.
To start the installation, 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
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 next steps depend on the release you are using:
The installation wizard will be displayed:
- If the wizard cannot locate a previous installation of the AIP Node package in the default installation location %USERPROFILE%\CAST (Windows),%PROGRAMFILES%\CAST\AipConsole (Windows), $HOME\CAST\AipConsole (Linux) or in the Window Registry (if installing on Windows), then the Install option will be automatically selected.
- If the wizard locates a previous installation of the AIP Node package in the default installation location %USERPROFILE%\CAST (Windows),%PROGRAMFILES%\CAST\AipConsole (Windows), $HOME\CAST\AipConsole (Linux) or in the Window Registry (if installing on Windows), then the Upgrade an existing installation option will be automatically selected. In this case:
- If you do not want to update the existing installation, ensure you choose the Install option and proceed with a "clean installation" in a different installation location.
- If you want to update the previous installation, please see Upgrade process.
Click to enlarge
Choose a location on the local machine that will be used for the AIP Node package installation. The setup will suggest: %PROGRAMFILES%\CAST\AipConsole but you are free to choose a different location. The package will be installed in a sub-folder called AipNode. If the folder does not already exist, the installation wizard will create it. Click Next to continue:
Choose a location for your AIP Node "data" - this location will contain items such as logs/delivery/deploy/upload/backup and other non-user specific items such as .properties files. The setup will suggest: %PROGRAMDATA%\CAST\AipConsole but you are free to choose a different location. A sub-folder called AipNode will be created to store the data items relating to the AIP Node package and the installation wizard will set Full Access permissions on the these folders to all authenticated users:
In previous releases of AIP Console, all these items were stored in <installation_location>\AipNode\data. You can modify the locations of the delivery, deploy, upload and backup folders when the installation is complete and before onboarding your first Application (recommended). See Configure AIP Node storage folder locations - optional.
Choose the installation packages you require - in this example we are installing only the AIP Node package (untick the AIP Console package). Click Next to continue:
If the installation wizard detects a previous installation in Step 1, and you have chosen the Install option, and you choose to install to the existing installation location, a check will be made to ensure the following folders are empty when you click Next:
The solution for both errors is to choose a different location for the installation by returning to Step 2 using the Previous button in the installation wizard.
Fill in the information that is required by the AIP Node package with regard to the port used, AIP Core location and CAST Storage Service/PostgreSQL options. Click Next to continue:
The token is then generated: in a multi analysis node installation scenario (i.e. large/enterprise) this token will be required when the AIP Console package is installed, (and also when adding the node to an already installed AIP Console) so take note of it:
Fill in the information that is required by the AIP Node package with regard to the Windows Service. Click Next to continue:
Choose whether to create shortcut icons and Start menu entries for the AIP Node package. The installation will start when you click Next:
The installation process will start. Click Next when complete:
The installation process is complete:
CLI console installation
Open a command prompt (for example CMD with elevated permissions (run as administrator)) and move to the location where the executable JAR file as provided with the installation media is stored. Start the installer in console mode by launching the following command:
java -jar AIP-Console-<version>.jar -console
The interactive console installer will then start. The steps for the installation process are similar to the GUI installation. Please refer to the GUI installation above for the list of required steps, parameters, default values, etc. Ensure you select ONLY the AIP Node package for installation:
Default values are indicated in square brackets (
[like this]) and will be used if the input is not filled with a different value.
|Available in AIP Console v. ≥ 1.16.|
It is possible to run the AIP Console installer in unattended mode using predefined settings stored in a specific file.
Create and configure .defaults files
|The .defaults file can contain configuration settings for both the AIP Console and AIP Node packages in a situation where you would like to install the AIP Node package on the same server as AIP Console. However, CAST recommends using a dedicated server for the AIP Node package.|
The first step is to create a .defaults file (you can name this however you want, for example unattended.defaults). This file contains the settings and options that you want to use for your unattended installation. An example is provided below containing all available options for installing the AIP Node package. Please refer to the GUI installation above for an explanation of the available options. Fill in the options to suit your own deployment scenario:
# CAST AIP Console installation configuration # Installation Directory for the applications - note that using $USER_HOME/CAST/ will auto translate to %USERPROFILE%\CAST\ INSTALL_PATH=C:/Program Files/CAST/AipConsole #Setup mode(custom,upgrade) - custom = "install" in the GUI installer. setup.mode=custom # Components to install # "full" to install everything # "cmsapi" to install AIP Node only # "webi" to install AIP Console only setup.type=cmsapi # ================== # AIP Node Configuration # ================== # CMS API Port cmsapi.port=8082 # CAST AIP location cmsapi.cast.ms.home= # Database host and port cmsapi.db.host=localhost:2280 # Database username cmsapi.db.username=operator # Database password cmsapi.db.password=CastAIP # ================== # Windows Services Configuration # ================== # Install as Windows Services (true by default) # windows.services.install=false windows.services.user=DOMAIN\\USER_NAME windows.services.password=
Run the installer with the .defaults file
To run the AIP Console installer in unattended mode, run the following command, changing the .default filename to the one you wish to use:
java -jar AIP-Console-<version>.jar -defaults-file unattended.defaults -auto
You can check that the installation completed by checking the following file to ensure that the settings you require have been correctly populated:
What is installed?
When the installation process is complete, the following will have been installed:
The package will be installed to the location specified in Step 1:
This is valid only for ≥ 1.19.x.
The package will be installed to the location specified in Step 3:
If you chose to create shortcuts during the installation they will be created, for example:
The following Windows Services will be created if you enabled the relevant option:
RAM considerations for Windows Services and startup batch scripts
"Out of the box", the Windows Services and batch scripts made available to run the AIP Nodes - which is a Java application - are configured to run with conservative RAM memory allocations as shown in the table below:
This means that even though the host server may have 64GB RAM available (for example), it will only give a maximum of 1GB to the JVM in which the AIP Nodes run. You may therefore find that this is not sufficient and you may receive low memory/out of memory errors when running analyses or snapshots. If this is the case, CAST recommends increasing the Xmx and Xms values until your low memory/out of memory exceptions have been resolved as explained below.
See Configuring RAM for AIP Console front-end and AIP Nodes for more information about changing the RAM allocations.