Introduction

In ≥ 2.0.0-funcrel, CAST provides Java JAR installers for each required service, as part of the download media available on CAST Extend (https://extend.castsoftware.com/#/extension?id=com.castsoftware.aip.console&version=latest):

These installers are an alternative to a deployment on Docker, however, they contain some limitations/constraints and require some additional manual configuration post installation. Therefore CAST highly recommends that Docker is used for an enterprise deployment scenario wherever possible - see AIP Console - front-end installation. If you do need to use the Java JAR installers, follow the steps below.

Limitations of the Java JAR installers

• In the "out of the box" configuration, it is not possible to access the Console front-end remotely (i.e. from another machine on the network). It is possible to make a manual change (see Optional post-installation configuration steps below) to allow remote access, however, as already mentioned, CAST highly recommends that Docker is used for an enterprise deployment scenario wherever possible.
• The Java JAR installers will automatically configure the required shared storage folders to use sub folders of the C:\aip-node-data path on the local machine. Therefore adding additional remote Nodes to this installation of Console will require that you share this folder path over the network, or make a manual change (see Optional post-installation configuration steps below) to change the paths to use a shared folder on the local network, however, as already mentioned, CAST highly recommends that Docker is used for an enterprise deployment scenario wherever possible.
• The deployment steps for using embedded CAST Dashboards are complex for Console v 2.0 - 2.2 and require manual intervention as described below. For Console ≥ 2.3 a Java JAR installer exists which configures the embedded Dashboard without manual intervention - see Embedded CAST Dashboard deployment process using Java JAR installer. Note that CAST highly recommends that Docker is used for an enterprise deployment scenario wherever possible where embedded Dashboard deployment is entirely automatic.
• The installation path for the "program data location" for the AIP-SSO service must not include any white space. The service may fail to start if the path contains any white space.

Launching the installers

The installers should all be run on one single host (although it is possible to install each service on different hosts, this is not recommended due to the additional complexity this creates). To start the installation of each Java JAR installers, double click the executable JAR file as provided with the installation media. If you are unable to execute the .JAR file, use the following command to open the JAR in GUI mode:

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

Step 1 - Run SSO/Keycloak installer - AIP-SSO-<version>.jar

The installation wizard will be displayed:

• If the wizard cannot locate a previous 2.x installation of the SSO service in the default installation location or in the Window Registry, then the Install option will be automatically selected.
• If the wizard locates a previous 2.x installation of the SSO service in the default installation location or in the Window Registry, then the Upgrade an existing installation option will be automatically selected.

Click Next to continue:

Choose a location on the local machine that will be used for the SSO service installation. The setup will suggest: %PROGRAMFILES%\CAST\AIP-SSO but you are free to choose a different location. If the folder does not already exist, the installation wizard will create it. Click Next to continue:

Choose a location for your SSO service "data" - this location will contain items such as logs. The setup will suggest: %PROGRAMDATA%\CAST\AIP-SSO but you are free to choose a different location (note that this path must not include any white space - services may fail to start if the path contains any white space). The installation wizard will set Full Access permissions on these folders to all authenticated users. Click Next to continue:

Fill in the information that is required by the AIP SSO service with regard to the port used for the service, admin user and CAST Storage Service/PostgreSQL options. A CAST Storage Service/PostgreSQL instance is required to store the SSO/Keycloak authentication data. Click Next to continue.

Fill in the information that is required by the SSO service with regard to the Windows Service. You are not obliged to install the service as a Windows Service: if you choose not to, you will need to start the service using a provided batch file (shortcuts to this batch file can be created in the following step). Click Next to continue:

Choose whether to create shortcut icons and Start menu entries for the SSO service. The installation will start when you click Next:

The installation process will start. Click Next when complete:

The installation process is complete:

Step 2 - Run Service Registry installer - AIP-Service-Registry-<version>.jar

The installation wizard will be displayed:

• If the wizard cannot locate a previous 2.x installation of the Service Registry service in the default installation location or in the Window Registry, then the Install option will be automatically selected.
• If the wizard locates a previous 2.x installation of the Service Registry service in the default installation location or in the Window Registry, then the Upgrade an existing installation option will be automatically selected.

Click Next to continue:

Choose a location on the local machine that will be used for the Service Registry service installation. The setup will suggest: %PROGRAMFILES%\CAST\AIP-Service-Registry but you are free to choose a different location. If the folder does not already exist, the installation wizard will create it. Click Next to continue:

Choose a location for your Service Registry service "data" - this location will contain items such as logs. The setup will suggest: %PROGRAMDATA%\CAST\AIP-Service-Registry but you are free to choose a different location. The installation wizard will set Full Access permissions on these folders to all authenticated users. Click Next to continue:

Configure the path to the shared network folders - CAST highly recommends that you use a shared network folder with appropriate read/write permissions, rather than a location on the local machine:

• common-data
• delivery
• deploy

Click Next to continue:

Fill in the information that is required by the Service Registry service with regard to the port used for the service and the CAST Storage Service/PostgreSQL options. A CAST Storage Service/PostgreSQL instance is required to store two schemas:

• aip_node
• aip_config

These schemas store persistence information about the Node(s) and Console front end itself. Click Next to continue.

Fill in the information that is required by the Service Registry service with regard to the Windows Service. You are not obliged to install the service as a Windows Service: if you choose not to, you will need to start the service using a provided batch file (shortcuts to this batch file can be created in the following step). Click Next to continue:

Choose whether to create shortcut icons and Start menu entries for the Service Registry service. The installation will start when you click Next:

The installation process will start. Click Next when complete:

The installation process is complete:

Step 3 - Run Gateway installer - AIP-Gateway-<version>.jar

The installation wizard will be displayed:

• If the wizard cannot locate a previous 2.x installation of the Gateway service in the default installation location or in the Window Registry, then the Install option will be automatically selected.
• If the wizard locates a previous 2.x installation of the Gateway service in the default installation location or in the Window Registry, then the Upgrade an existing installation option will be automatically selected.

Click Next to continue:

Choose a location on the local machine that will be used for the Gateway service installation. The setup will suggest: %PROGRAMFILES%\CAST\AIP-Gateway but you are free to choose a different location. If the folder does not already exist, the installation wizard will create it. Click Next to continue:

Choose a location for your Gateway service "data" - this location will contain items such as logs. The setup will suggest: %PROGRAMDATA%\CAST\AIP-Gateway but you are free to choose a different location. The installation wizard will set Full Access permissions on these folders to all authenticated users. Click Next to continue:

Fill in the information that is required by the Gateway service with regard to the port used for the service. Click Next to continue:

Fill in the information that is required by the Gateway service with regard to the Windows Service. You are not obliged to install the service as a Windows Service: if you choose not to, you will need to start the service using a provided batch file (shortcuts to this batch file can be created in the following step). Click Next to continue:

Choose whether to create shortcut icons and Start menu entries for the Gateway service. The installation will start when you click Next:

The installation process will start. Click Next when complete:

The installation process is complete:

Step 4 - Install the Node service

You should now run the Node service installer, as is the case with a standard deployment. See AIP Node service - back-end installation.

Step 5 - Initial configuration

Ensure all services are up and running

The next step is to first ensure that all services are up and running.

• If you installed them as Windows Services and chose to start the service as well, all services should be up and running correctly.
• If you installed them as Windows Service and chose NOT to start the service, you will need to start the services in the following order:
  • SSO/Keycloak
  • Service Registry
  • Gateway
  • Node
• If you did NOT install them as Windows Services, you will need to run the following batch files to start the services in the order listed below - wait until each service is fully started before starting the next one.

Perform the initial configuration steps

See Initial configuration steps - v. 2.x for more information.

Step 6 - deploy Dashboards

Embedded dashboards

≥ 2.3.x

Please see the information in Embedded CAST Dashboard deployment process using Java JAR installer.

2.0.x - 2.2.x

<unpacked_zip>\startup.bat

java -jar -Xmx1024m -Xms256m cast-integrated-health-engineering-dashboard-<version>.jar

<unpacked_zip>\configurations\application.properties

<unpacked_zip>\configurations\application-integratedv2.properties

configServerUrl=http://localhost:8088/config

<unpacked_zip>\configurations\roles.xml

<unpacked_zip>\configurations\roles-v2.xml

<unpacked_zip>\configurations\datasource.properties

jdbc:postgresql://${db.host}:2284/postgres

jdbc:postgresql://$192.168.200.104:2282/postgres

<unpacked_zip>\startup.bat

java -Dloader.path="${UserPathPanelVariable}" -jar -Xmx1024m -Xms256m cast-integrated-health-engineering-dashboard-<version>.jar

java -Dloader.path="${UserPathPanelVariable}" -jar -Xmx1024m -Xms256m cast-integrated-health-engineering-dashboard-<version>.jar --spring.config.import=optional:file:configurations/datasource.properties

<unpacked_zip>\startup.bat

Standalone dashboards

See Standalone CAST Dashboard deployment process.

Step 7 - Configuration steps to allow remote access to Console and for the installation of remote Nodes

Automated (unattended) installation

It is possible to run the Service Registry and Gateway installers in unattended mode using predefined settings stored in a specific file - see the instructions below (it is not possible to do this for the SSO installer).

Create and configure .defaults files

The first step is to create a .defaults file (you can name this however you want, for example unattended.defaults) for each installer. This file contains the settings and options that you want to use for your unattended installation. Examples are provided below containing all available options. Please refer to the GUI installation above for an explanation of the available options. Fill in the options to suit your own deployment scenario:

.

# AIP Service Registry installer config values
# Installation folder for executables
INSTALL_PATH=C:/Program Files/CAST/AIP-Service-Registry/bin
# Type of installation
# Automatically detected by the installer, but you can overwrite it using this parameter
# setup.mode=install
# Data folder
dataFolder=C:/Program Files/CAST/AIP-Service-Registry/data
# Port for the standalone server
server.port=8088

# Database configuration for service registry
db.host=localhost:2282
db.user=operator
db.password=CastAIP
db.database=postgres

# Install as a service
windows.service.install=false
# Start service after installation
windows.service.startAfterInstall=false
# Use a user account for the service
windows.service.isUserAccount=false
# User account name/password (don't forget the domain in the username; should be like DOMAIN\\USER - double backslashes)
windows.service.user=
windows.service.password=

# Create shortcuts on desktop
DesktopShortcutCheckboxEnabled=true

# AIP Gateway installer config values
# Installation folder for executables
INSTALL_PATH=C:/Program Files/CAST/AIP-Gateway/bin
# Type of installation
# Automatically detected by the installer, but you can overwrite it using this parameter
# setup.mode=install
# Data folder
dataFolder=C:/Program Files/CAST/AIP-Gateway/data
# Port for the gateway server
server.port=8081
# Configuration server URL
configServerUrl=http://localhost:8088/config

# Install as a service
windows.service.install=false
# Start service after installation
windows.service.startAfterInstall=false
# Use a user account for the service
windows.service.isUserAccount=false
# User account name/password (don't forget the domain in the username; DOMAIN\\USER - double backslashes)
windows.service.user=
windows.service.password=

# Create shortcuts on desktop
DesktopShortcutCheckboxEnabled=true

Run the installer with the .defaults file

To run the installer in unattended mode, run the following command, changing the .default filename to the one you wish to use and updating the name of the .jar file:

java -jar AIP-<component>-<version>.jar -defaults-file unattended.defaults -auto

Troubleshooting

During the unattended installation, some elements will be checked automatically and may result in an installation failure:

• "Invalid CAIP folder location": please check that the caipFolder property points to an existing installation of AIP Core
• "Unable to access database": please make sure the information to access the database is properly set.
• "Unable to start service": after installation, the service may not be started properly. Please check in the Windows Services that the service details were set correctly and check that the service can be started.

Optional - Configuration steps to change data folder storage

To change the paths to the data storage folders defined in the Service Registry installer you will need to run an SQL query: using pgAdmin, connect to the CAST Storage Service/PostgreSQL instance on which the aip_config schema has been installed (as described in Step 2 - Run Service Registry installer above). Locate the properties table in the aip_config schema and then locate the following entries:

• application.paths.delivery-folder
• application.paths.deploy-folder
• application.paths.shared-folder

Click to enlarge

The Value column contains the paths used - change all three paths to use your preferred shared network folder, for example:

• \\server\share\delivery
• \\server\share\deploy
• \\server\share\common-data

After making the change restart all services.

RAM considerations for Windows Services and startup batch scripts

 "Out of the box", the Windows Services and batch scripts made available to run the services 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 each service runs. 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.