Deployment requirements

Mon, 01 Jan 0001 00:00:00 +0000

Info

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:

This mode uses microservices architecture: all Console front-end services (authentication, UI, registration, Dashboards etc.) are provided either:
- as Docker containers
- or can be installed via Java JAR installers where Docker cannot be used
When using Docker/Docker Desktop:
- the deployment of CAST Dashboards is entirely automatic and no manual configuration is required
- upgrades to new releases of Console is simple - pull/rebuild new images for the containers
The Node service is provided as a separate Java JAR installer for installation on Microsoft Windows and can be installed on multiple hosts where AIP Core exists

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:

Uninstall AIP Console

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: Information about uninstalling the Console / Node services.

2.x

Front-end Console services

Deployed as Docker containers on Linux

When the front-end services are installed as Docker containers and you want to completely remove all trace of Console, perform the following actions. First move to the location where the docker-compose.yml file is stored, for example:

cd /CAST/CONSOLE

Now run the following docker commands with elevated permissions:

# Stop all containers and remove all containers, networks, volumes, and images created by the up command:
docker-compose down

# Remove all unused local volumes created by the up command, e.g. "restapi-domains" (for embedded Dashboards) and "db-data" (for the PostgreSQL instance):
docker volume prune

# Remove all unused containers, networks, images (both dangling and unreferenced), and optionally, volumes:
docker system prune -a

Info

The commands listed above will remove all items configured in Docker, not just Console related items!

AIP Console - Delivery Modes

Mon, 01 Jan 0001 00:00:00 +0000

Info

Valid for Console ≥ 1.26.

Introduction

Console provides two delivery modes:

Mode

Description

Benefits

Disadvantages

Standard, with version history

This mode is the standard mode that has been used in all releases of Console and is the default for Console ≥ 1.26 when using the Workflow - Application onboarding without Fast Scan.

Source code for a given version is:
- either uploaded as a ZIP file and is then unpacked in the upload folder on the relevant Node
- or accessed directly from the specified source folder location
Source code is then compressed and copied into the Delivery folder, therefore retaining version history
Source code is then copied to the Deploy folder and is analyzed from there.

The copying of source code multiple times into various different folders can reduce overall version processing time (i.e. total time taken from specifying the source code to generating the snapshot) and increase the amount of disk space required for source code storage.

AIP Console - Use of Regular Expressions

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Console uses the Java Regular Expression system for defining Regular Expressions items used in the following features:

Transaction configuration rules
Excluded table names for transaction built-in data entities
Architecture models and Quality Rules

You can find out more about this here: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.

Info

Note that the Reference Finder does not use Java Regular Expressions - it uses Python Regular Expressions instead.

Example patterns

Some example patterns are shown below:

AIP Console - Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: A list of issues and problems that may occur and how to solve them.

All releases

ZIP archive file is not processed

If your ZIP archive file is not accepted by CAST Console, or causes the onboarding action to not finish, then the ZIP may be corrupt or otherwise incorrectly compressed. CAST recommends unzipping the archive file and then re-zipping to ensure that the ZIP is created correctly.

CAST Console on Documentation - V2

Deployment requirements

Typical architecture

2.x

Deployment modes

Uninstall AIP Console

2.x

Front-end Console services

Deployed as Docker containers on Linux

AIP Console - Delivery Modes

Introduction

AIP Console - Use of Regular Expressions

Introduction

Example patterns

AIP Console - Troubleshooting

All releases

ZIP archive file is not processed