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

Step 1 - ensure deployment requirements are in place

Ensure that all requirements are in place. This includes the installation of any third-party software that is required to run Docker. Installation and configuration of third-party software is out of scope of this documentation, however, some tips can be found in the following documentation: 

Ubuntu 

CentOS

Step 2 - download and unpack CAST AIP Docker Installer

The installation files are available as an extension (CAST AIP Docker Installer) published by CAST - see https://extend.castsoftware.com/#/extension?id=com.castsoftware.aip.docker&version=latest. Download the extension from CAST Extend using curl:

curl -O -J "https://extend.castsoftware.com/api/package/download/com.castsoftware.aip.docker" -H "x-nuget-apikey: <key>" -H "accept: application/octet-stream"

Then unpack the ZIP that has been downloaded:

unzip com.castsoftware.aip.docker.1.0.0-funcrel.zip

The following files will be produced when the extension is unzipped:

start_docker_caip.bat (for Microsoft Windows)
start_docker_caip.sh (for Linux)

Step 3 - Run the installer

Run the Linux installer script with the following command:

./start_docker_caip.sh
Note that you may need to run "chmod +x ./start_docker_caip.sh" to grant execution permission to the script before running it. You may also need to run this file with elevated permissions (e.g. sudo).

Step 4 - Choose simple or advanced installation

The installer will run and offer you a choice between simple or advanced install mode:

Simple mode
  • Deploy AIP Console (front end).
  • Data (AIP Console persistence database etc.) is stored by default within the Docker container. This means that if the container is deleted, this data is lost.

In this scenario, all items are installed within the Docker environment. Access is granted to the AIP Console (front end) outside the Docker environment via a TCP port number for user access and management. In other words, this is a "closed" installation entirely residing within Docker.

Advanced mode

Choice of deployment scenario:

  • Deploy AIP Console (front end).
  • Choose to store the data (AIP Console persistence database etc.) in a specific location on the server.

Simple mode

Choosing simple mode will require you to input additional details to expose the ports required for users/services to access the items within the Docker environment:

AIP Console portThis is the port number which end-users will use to communicate with the AIP Console (front end) in their browsers - the default is 8081. If the port is already being used by another service on the server, you can choose another custom port (for example port 80).

In a new installation, no existing containers will be detected, and the installer will then create a new Docker container with the default name castcaip_1. You can enter a custom name if you prefer:

The installer will then start the process of pulling the Docker image:

The container will then start:

The items are all downloaded directly from https://hub.docker.com/.

Advanced mode

In Advanced mode, you will first be prompted to input additional details to expose the ports required for users/services to access the items within the Docker environment:

AIP Console portThis is the port number which end-users will use to communicate with the AIP Console (front end) in their browsers - the default is 8081. If the port is already being used by another service on the server, you can choose another custom port (for example port 80).

Finally you will be prompted to choose whether you want to keep the data generated by CAST AIP (AIP Console persistence database etc.) within the container (enter No), or in a specific location on the server (enter Yes). If you choose Yes, you will need to enter a "root" folder that will be used for the CAST AIP data, for example /var/opt/cast/aipconsole/db (this path must already exist):

In a new installation, no existing containers will be detected, and the installer will then create a new Docker container with the default name castcaip_1. You can enter a custom name if you prefer:

The installer will then start the process of pulling the Docker image:

The container will then start:

The items are all downloaded directly from https://hub.docker.com/.

Step 5 - obtain configuration key

Before continuing with the deployment, you must obtain the configuration key, which is required during the initial setup of the AIP Console front-end. This key is displayed in the final summary:

The configuration key is required when first starting AIP Console - see Complete start-up wizard. Note that the path location displayed in the wizard will be false (it is will show the location within the Docker container).


Step 6 - check container and image

Run the following command to check that the image is up and running:

docker ps

Next steps

When the deployment is complete and depending on the installation choices you made, you may wish to consult further documentation to explain what to do next:

AIP Console deployedYou will need to Complete start-up wizard to prepare your environment.
  • No labels