See also Infrastructure sizing guide for more detailed information.
Typical architecture
2.x
Click to enlarge
Deployment modes
Before beginning the installation process, you should be aware of the various deployment methods available:
| Release | Deployment mode | Deployment scenario | Details |
|---|---|---|---|
| 2.x | Enterprise | Docker for Linux or Docker Desktop for Microsoft Windows | Enterprise mode using Docker is highly recommended wherever possible:
|
| Enterprise | Single installer (exe) for Microsoft Windows only | ||
| Enterprise | Java JAR installers (multiple) | ||
| Standalone | Java JAR installer (single) for Microsoft Windows only | Standalone mode is targeted at deployments on Microsoft Windows on one single machine. The installer includes all required services in one single Java JAR installer:
Note that this mode has some limitations which are explained in 2.x - Standalone mode - Installation of AIP Console front-end in standalone mode. | |
| 1.x | - | Java JAR installer (single) | In 1.x, one single Java JAR installer is provided containing:
|
Console (front end) package requirements
2.x - Docker install
| Software | Required | Notes |
|---|---|---|
| Host Operating System |  | Microsoft Windows
See https://docs.docker.com/desktop/windows/install/. Linux
|
Third-party software required | | Docker on Linux
|
Docker on Microsoft Windows
Note that when using Hyper-V mode for Docker Desktop only, the following must also be configured:
When using WSL2 mode, these changes are not required. Docker Desktop will automatically manage RAM memory and file sharing. | ||
| Access to at least one CAST Storage Service /PostgreSQL | | An installation of the CAST Storage Service/PostgreSQL, which must be accessible over the network. This is used to host the schemas required for storing analysis results - these schemas do not need to be pre-installed as Console will manage their installation.
Note that a PostgreSQL instance is provided as a Docker container running on port 2285 - it will be preconfigured in Console. This instance is used to store the following:
This CAST Storage Service/PostgreSQL instance can ALSO be used to host schemas (Management, Analysis, Dashboard, Measurement) that are required for analysis/snapshot storage. |
| Ports | | The following ports must be opened inbound on the host server. These correspond to each Docker container required by Console (front-end). This is so that remote Node instance can access the required services:
These ports can be customized if required. |
| User permissions | | To run the Docker install, Administrator privileges are required:
|
| Access to hub.docker.com | | All Docker containers are pulled direct from https://hub.docker.com/, therefore the host server must have access to this. |
| Global CAST License | | Console requires a global CAST license key. This key will be applied to all Node packages that you install. |
| CAST Extend | | In order to install any CAST AIP Extensions automatically, Console needs to connect to CAST's managed service known as "Extend" over the public internet. You will therefore need to register a CAST Extend account (https://extend.castsoftware.com/#/register) and generate an API key (this key is used by Console in the start-up wizard). In addition, access to the following URL on port 443 via TCP is required: Note that if (due to security concerns) your organization cannot interact over the public internet with CAST's managed services, you can alternatively use CAST Extend Offline/Proxy. |
2.x - Multiple JAR install
The JAR installers are an alternative to a Docker deployment. See 2.x - Enterprise mode - Installation of AIP Console front-end via Java JAR installers.
| Software | Required | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Host Operating System | | Supported versions of Windows:
Installations of Windows Server using only Server Core (i.e. without a GUI) are not supported.
| ||||||||||||||||||||||||
Java (JRE/JDK) | | A 64bit Java JRE or JDK is required to install and run Console. Most Java variants certified by the OpenJDK Community Technology Compatibility Kit are compatible with Console (you can verify if a company has access to the TCK on the OpenJDK website). However, CAST highly recommends using the following LTS releases which are known to function with v. ≥ 2.0:
| ||||||||||||||||||||||||
| JAVA_HOME environment variable | | A JAVA_HOME system wide environment variable must exist on all host machines, pointing to the installation location of your Java JRE or JDK. | ||||||||||||||||||||||||
| Access to at least one CAST Storage Service /PostgreSQL | | An installation of at least one CAST Storage Service/PostgreSQL, which must be accessible over the network. This is used to host various items required by Console/Nodes:
You can use one single CAST Storage Service/PostgreSQL to host all required items, or dedicated CAST Storage Service/PostgreSQL instances to host each item. Note that the CAST Storage Service/PostgreSQL instance defined in the Service Registry Java installer will also be made available for use as storage for application analysis/snapshot requirements. | ||||||||||||||||||||||||
| Ports | | The various services run on the following ports by default:
These ports can be customized if required. | ||||||||||||||||||||||||
| User permissions | | To run the setup start and run the Console package on the server, the follow user permissions are required:
| ||||||||||||||||||||||||
| Global CAST License | | Console requires a global CAST license key. This key will be applied to all Node packages that you install. | ||||||||||||||||||||||||
| CAST Extend | | In order to install any CAST AIP Extensions automatically, Console needs to connect to CAST's managed service known as "Extend" over the public internet. You will therefore need to register a CAST Extend account (https://extend.castsoftware.com/#/register) and generate an API key (this key is used by Console in the start-up wizard). In addition, access to the following URL on port 443 via TCP is required: Note that if (due to security concerns) your organization cannot interact over the public internet with CAST's managed services, you can alternatively use CAST Extend Offline/Proxy. |
1.x - JAR install
| Software | Required | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Host Operating System | | The Console package can be installed on both Windows and Linux operating systems:
Installations of Windows Server using only Server Core (i.e. without a GUI) are not supported.
| ||||||||||||||||||||||||
Java (JRE/JDK) | | A 64bit Java JRE or JDK is required to install and run Console. Most Java variants certified by the OpenJDK Community Technology Compatibility Kit are compatible with Console (you can verify if a company has access to the TCK on the OpenJDK website). However, CAST highly recommends using the following LTS releases which are known to function with v. ≥ 1.14.0:
sudo update-alternatives --config java
| ||||||||||||||||||||||||
| JAVA_HOME environment variable | | A JAVA_HOME system wide environment variable must exist on all host machines, pointing to the installation location of your Java JRE or JDK. | ||||||||||||||||||||||||
| User permissions | | To run the setup start and run the Console package on the server, the follow user permissions are required:
| ||||||||||||||||||||||||
| Access to Node(s) | | The Console package requires access to the analysis nodes on which the Node package/AIP Core has been installed:
| ||||||||||||||||||||||||
| Access on port 8081 | | The Console package runs by default on port 8081 (although you can customize this if required - CAST recommends enabling secure HTTPS connection) therefore you will need to adjust firewall rules on the host server to allow access to the appropriate port so that users can access Console in their browser. | ||||||||||||||||||||||||
| Global CAST License | | The Console package requires a global CAST license key. This key will be applied to all Node packages that you install. | ||||||||||||||||||||||||
| CAST Extend | | In order to install any CAST AIP Extensions automatically, Console needs to connect to CAST's managed service known as "Extend" over the public internet. You will also need login credentials for Extend - i.e. you will need to register an account. Access to the following URL on port 443 via TCP is required: Note that if (due to security concerns) your organization cannot interact over the public internet with CAST's managed services, you can alternatively use CAST Extend Offline/Proxy. |
Node (back end) package requirements
See also Managing multiple applications in Hardware requirements for more information.
| Software | Required | Notes | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Host Operating System | | The Node package must be installed on a Windows host operating system since it requires the presence of AIP Core. Supported versions of Windows:
| ||||||||||||||
| AIP Core | | A standard installation (i.e. run from the AIP Core setup) of AIP Core ≥ 8.3.6 is required on the target node.
| ||||||||||||||
| CAST Storage Service /PostgreSQL | | An installation of the CAST Storage Service/PostgreSQL, which must be available either on the target node or on another dedicated server accessible over the network. This is used to host the schemas required for storing analysis results - these schemas do not need to be pre-installed as Console will manage their installation.
| ||||||||||||||
| Java (JRE/JDK) | | A Java JRE or JDK is required to install and run Node. See Java (JRE/JDK) above for more information about requirements. | ||||||||||||||
| JAVA_HOME environment variable | | A JAVA_HOME system wide environment variable must exist on the host machine, pointing to the installation location of your Java JRE or JDK. | ||||||||||||||
| Data storage folders | | The following folders are required by the Node and must be accessible. CAST recommends the use of a common network share for all Nodes. Note however that in v. 1.x, these folder will be located, by default on each Node.
| ||||||||||||||
| Network access | | v. 2.x The Node package runs on the following ports (this port is used for communication from the Node to Console):
The Node instance requires outbound access from the following default ports to the server hosting Console:
In addition, outbound access to any CAST Storage Service/PostgreSQL instances configured for Analysis/Snapshot/Measurement storage requirements is required. v. 1.x The Node package runs by default on port 8082 (although you can customize this if required - CAST recommends enabling secure HTTPS connection) and this port is used for communication from Console to the Node(s), therefore you will need to adjust firewall rules on the Node instance to allow inbound access from Console. In addition, outbound access to any CAST Storage Service/PostgreSQL instances configured for Analysis/Snapshot/Measurement storage requirements is required. | ||||||||||||||
| CAST Extend | | In order to install any CAST AIP Extensions automatically, each Node needs to connect to CAST's managed service known as "Extend" over the public internet. You will also need login credentials for Extend - i.e. you will need to register an account: Access to the following URL on port 443 via TCP is required: Note that if (due to security concerns) your organization cannot interact over the public internet with CAST's managed services, you can alternatively use CAST Extend local server. | ||||||||||||||
| User permissions | | To run the setup and start/run the Node package on the server, local Administrator privileges are required. |
Requirements for end users accessing Console and embedded Dashboards
Browsers
The following browsers are supported when run on Linux, macOS or Microsoft Windows. We regularly test with a subset of the available versions, and aim to fix issues found with any of them.
Browser | Supported | Notes |
|---|---|---|
| Microsoft Edge | | Minimum supported release: 44 and above |
Mozilla Firefox | | Minimum supported release: 95 and above |
| Google Chrome | | Minimum supported release: most recent only |
| Safari | | Minimum supported release: 12 and above |
See Standalone dashboard - installation requirements if you intend NOT to use the Dashboards embedded in CAST Console.
Technical information about Keycloak
CAST uses a third-party component called Keycloak to handle authentication for CAST AIP Console. This component is provided and installed automatically. Some technical information about Keycloak follows:
Product support
CAST supports this third-party component in the sense that tickets are created, and temporary or permanent fixes will be provided.
Version upgrades
When a permanent fix is required, CAST provides the latest corrections published by Keycloak.
Error management
CAST handles Keycloak errors when they are reported via support tickets.
Configuration and parameterization issues
As mentioned previously, CAST handles configuration issues when support tickets are created.
Software and security patching
When patching is required, CAST provides patches sourced from Keycloak.
