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

Summaryinformation to help you plan your AIP for Imaging installation.

CAST Imaging

Traditional installer for Microsoft Windows

SoftwareRequiredNotes
Host Operating System(tick)

Microsoft Windows

  • Windows Server 2019 (64bit) - supported in CAST Imaging ≥ 1.6.0
  • Windows Server 2016 (64bit)
  • Windows Server 2012 (64bit)

Installations of Windows Server using only Server Core (i.e. without a GUI) are not supported.

JDK(tick)

A JDK (1.8.x 64bits) is required. Supported versions are as follows:

  • OpenJDK

  • Oracle Java

Powershell(tick)

The ability to execute Powershell scripts is required during the installation process.

Docker (Microsoft Windows or Linux)

SoftwareRequiredNotes
Host Operating System(tick)

Microsoft Windows

  • Windows Server 2019 (64bit) and cumulative update of September 2020

Installations of Windows Server using only Server Core (i.e. without a GUI) are not supported.

Linux

  • Ubuntu Server (16.04 LTS / 18.04 LTS / 20.04 LTS)
  • CentOS (7 or 8)

Third-party software required
for install on Docker (Linux and Windows)


(tick)

Docker on Linux

When using the Docker Installer extension

  • Docker Engine ≥ 18.0
  • docker-compose ≥ 3.0
  • curl

Docker on Microsoft Windows

  • Docker Desktop for Windows - latest version recommended, or one that provides:
    • Docker Engine ≥ 19.03.5
    • docker-compose ≥ 3.0
    • Containers for Linux must be enabled
  • Resources for Docker:
JDKOptional

A JDK (1.8.x 64bits) is required if using SAML authentication to generate the public/private key pairs for SAML/SSL . Supported versions are as follows:

  • OpenJDK

  • Oracle Java

Kubernetes cluster

SoftwareRequiredNotes
Kubernetes(tick)

Supported in CAST Imaging ≥ 2.1.0.

See https://github.com/CAST-Extend/com.castsoftware.imaging.kubernetessetup for more information.

Helm(tick)

License key

CAST Imaging requires a license key before any Application data can be imported. Please contact CAST Support to obtain your license key.

Required ports

Windows Service nameDocker container nameDescriptionDefault Listening PortNotes
CAST Imaging System - imaging-ETLetlCAST Imaging application management service.9001-
CAST Imaging System - Frontend servicenginxCAST Imaging front-end web service.

80 (≤ 2.0.0-beta5)

8083 (≥ 2.0.0-beta6)

For ≥ 2.0.0-beta6, if port 8083 is not free, the next available port will be used.
From 2.1.0-funcrel this image is no longer pushed. Merged into "server".
CAST Imaging System - imaging-serviceserverCAST Imaging back-end web service.9000-
CAST Imaging System - login serviceloginCAST Imaging login and authentication service.8084From 2.1.0-funcrel this image is no longer pushed. Merged into "server".
CAST Imaging System - sourcecode servicesourcecodeCAST Imaging sourcecode service.9980From 2.1.0-funcrel this image is no longer pushed. Merged into "server".
CAST Imaging System - Neo4j Graph Databaseneo4jNeo4j Graph Database instance.7473, 7474, 7687-

End users accessing CAST Imaging - browsers

BrowserSupportedNotes
Microsoft Edge(tick)Minimum supported release: Windows 10 Creators Update (1703)

Mozilla Firefox

(tick)Minimum supported release: 63.0
Google Chrome(tick)Minimum supported release: ≥ 70.0

Analysis Service schema

Analysis Service schemas from the following releases of AIP Core are supported for data generation and import:

CAST AIP 8.3.x(tick)
CAST AIP 8.2.x(tick)


  • Currently, it is possible to extract data only from an Analysis Service which contains a single Application.
  • The actions generate snapshot or prepare snapshot (where the Application does not contain any Architecture Models, or transaction/data call graphs) must have already been run before data generation and import takes place. Note that where the prepare snapshot or generate snapshot actions have already been run and a subsequent "run analysis only" is executed on the entire Application or one single Analysis Unit within the Application, you must either run the prepare snapshot or generate snapshot options again BEFORE data generation and import takes place.

AIP Console (front end) package requirements

(tick)Host Operating System

The AIP Console package can be installed on both Windows and Linux operating systems:

  • Supported versions of Windows:
    • Windows Server 2019 (supported in AIP Console ≥ 1.10.0)
    • Windows Server 2016
    • Windows Server 2012 R2 Standard
    • Windows Server 2012 Standard
    • Windows Server 2008 R2 SP1 Standard
    • Windows 10
    • Windows 8.1
  • Recommended versions of Linux:
    • Ubuntu
    • CentOS
    • Red Hat
    • Debian
    • Fedora
(tick)Java (JRE/JDK)

A 64bit Java JRE or JDK is required to install and run AIP Console.

Any Java variants certified by the OpenJDK Community Technology Compatibility Kit are compatible with AIP Console (you can verify if a company has access to the TCK on the OpenJDK website). The following are known to function with v. ≥ 1.14.0:

ProviderJava 8 64bitJava 11 (LTS) 64bitJava 13 64bitJava 14 64bitJava 16 64bit
Oracle JDK (http://jdk.java.net/)(tick)(tick)(tick)(tick)(tick) (see note below)
AdoptOpenJDK(tick)(tick)(tick)(tick)(tick) (see note below)
Amazon Corretto(tick)(tick)N/AN/AN/A
Eclipse OpenJ9(tick)(tick)(tick)N/AN/A
Azul Zulu(tick)(tick)(tick)(tick)(tick) (see note below)
  • If you have multiple JDK versions installed on a Linux server, you can set the default using the following command:
sudo update-alternatives --config java
  • Java 16 is more restrictive regarding java library use and limits some elements to specific modules that are not enabled by default. As a result of this, although supported for use with AIP Console, the start up batch/script files delivered with the installer for the AIP Console front-end and back-end AIP Node must be modified before they can be used to launch AIP Console or an AIP Node. See Configuring start up services and scripts for use with Java 16.
(tick)User permissions

To run the setup start and run the AIP Console package on the server, the follow user permissions are required:

WindowsLocal Administrator privileges
LinuxRoot privileges (for example use the sudo / su commands when running the launch script)
(tick)Access to AIP Node(s)

The AIP Console package requires access to the analysis nodes on which the AIP Node package/AIP Core has been installed:

  • AIP Console package version number and the AIP Node package version number must be identical.
  • If you are installing the AIP Node package on multiple analysis nodes, then you need to ensure that the AIP Console package can access the AIP Nodes via the defined URLs - i.e. you may need to adjust firewall rules on the AIP Nodes to allow access on the defined port.
(tick)Access on port 8081The AIP 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 the AIP Console in their browser.
(tick)Global CAST AIP LicenseThe AIP Console package requires a global CAST AIP license key. This key will be applied to all AIP Node packages that you install.
(tick)CAST Extend 

In order to install any CAST AIP Extensions automatically, AIP 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.

AIP Node (back end) package requirements

(tick)Host Operating System

The AIP Node package must be installed on a Windows host operating system since it requires the presence of AIP Core. Supported versions of Windows:

  • Windows Server 2019 (supported in AIP Console ≥ 1.10.0)
  • Windows Server 2016
  • Windows Server 2012 R2 Standard
  • Windows Server 2012 Standard
  • Windows Server 2008 R2 SP1 Standard
  • Windows 10
  • Windows 8.1
(tick)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.

  • from v. ≥ 1.16, AIP Console can manage multiple AIP Nodes using different releases of AIP Core. In previous releases, the same release of AIP Core must be used across all AIP Nodes managed in the same AIP Console installation.
  • CAST recommends the most recent release of AIP Core to take full advantage of all available features.
  • The installation path for AIP Core is referred to as <CAST_AIP_install> in the rest of this document. By default, the path is C:\Program Files\CAST\<version>\ on each AIP Node.
(tick)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 the AIP Console will manage their installation.

  • You can use one single CAST Storage Service/PostgreSQL for all AIP Nodes and Measurement schema
  • You can use multiple CAST Storage Services/PostgreSQL - one dedicated server per AIP Node and one dedicated server for the Measurement schema for example
(tick)Java (JRE/JDK)

A Java JRE or JDK is required to install and run AIP Node. See Java (JRE/JDK) above for more information about requirements.

(tick)Folders
These folders are only required in AIP Console ≤ 1.8.x. In ≥ 1.9.x, these folders are created automatically in the AIP Node "data" folder.

The following folders must be present on the local disk of the target node already. Ensure that you have adequate disk space to store at least double your Application's source code:

FolderDescription
DeliveryA location for storing successive and compressed versions of an application's source code as packaged by the Delivery Manager(s).
DeployA location used to store the most recent version of the application's source code for analysis in uncompressed format.
API_UploadA folder on the target node is required for user uploads - i.e. components that may need to be added to an analysis (for example).
  • The installer will suggest the folders are located in C:\CASTMS, but you are free to create them wherever appropriate on the local disk.
  • All folders must be writable by the Windows user installing the AIP Node package.
  • All folders must be empty.
(tick)Access on port 8082The AIP 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 between the AIP Console and the AIP Node(s), therefore you will need to adjust firewall rules on the host server to allow access to the appropriate port.
(tick)CAST Extend

In order to install any CAST AIP Extensions automatically, each AIP 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 Offline/Proxy.
(tick)User permissionsTo run the setup and start/run the AIP Node package on the server, local Administrator privileges are required.

Requirements for end users accessing AIP Console

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(tick)Minimum supported release: 44 and above

Mozilla Firefox

(tick)Minimum supported release: 65 and above
Google Chrome(tick)Minimum supported release: most recent only
Safari(tick)Minimum supported release: 12 and above

CAST Extend Offline/Proxy (optional) requirements

See:

CAST Storage Service / PostgreSQL storage

See:

Supported features of Directory Systems

Directory Services

(tick)
  • Microsoft Active Directory is full supported.
  • Other Directory Services are supported in AIP Console/CAST Imaging but will generally require additional configuration.

Microsoft Active Directory Lightweight Directory Services

Partially

Microsoft AD LDS does not have all the information in the server itself, but may provide a pointer to another server where that information is stored. Depending on what is stored, authentication and authorization may fail if pointing to a AD LDS server and not enough information is present. If this occurs, the configuration should be modified to point to a full Microsoft Active Directory server.

Global Catalog Servers (GCS)(tick)

Sometimes required if an Active Directory or other Directory Services server contains multiple domains or domains and sub-domains. as the Global Catalog Server contains LDAP information for all domains. In this case the LDAP URL should point to the GCS server URL (normally same as LDAP URL with port 3268 for LDAP and 3269 for LDAPS)

Proxies

Partially
  • If the proxy has no authentication configured, then they are supported.
  • No support for any Single Sign On (SSO) proxies.

Referrals

PartiallyIf a referral is used, the machine name needs to be able to be resolved the Doman Name Service (DNS) process. This may require that DNS or a local hosts file is modified to ensure that it occurs.

SSO (Single Sign On)

(tick)

Supported for AIP Console/CAST Imaging via SAML

Nested Groups(tick)-
  • No labels