Introduction
CAST provides a single Docker image for Microsoft Windows and Linux (available in Docker hub) that includes the CAST AIP Components listed below. It has been implemented to facilitate CAST AIP deployment. The image is deployed via the CAST AIP Docker Installer (an interactive batch script) in a unique container created by the installer and you can therefore install multiple CAST AIP containers in the Docker environment - for example to install multiple AIP Nodes on the same server within Docker.
Docker for Microsoft Windows | Docker for Linux | |
---|---|---|
AIP Console (front end) - including embedded CAST Dashboards | AIP Console (front end) - including embedded CAST Dashboards | |
AIP Core (currently only for Management/Engineering - Dashboard) | - | |
CAST Extend Proxy | - |
Installation is flexible and you can install all these components or different combinations of them within the container created by the installer:
Docker for Microsoft Windows
- Deploy AIP Console (front end), AIP Node (back end), AIP Core and Extend Proxy (without extensions)
- Deploy AIP Console (front end), AIP Node (back end) and AIP Core
- Deploy AIP Node (back end) and AIP Core - this option is designed for use with an existing AIP Console (front end) deployed elsewhere in your environment
- Choose to store the data (Delivery, Deploy, Logs, LISA, LTSA etc.) in a specific location on the server or on a network share, or leave it with the Docker container
Docker for Linux
- Deploy AIP Console (front end)
- Choose to store the AIP Console persistence database in a specific location on the server, or leave it with the Docker container
Which releases of CAST AIP components are provided in the image?
The Docker image provided by CAST will contain the most recent "funcrel" releases of each component where possible. Images are updated as soon as new releases of components are shipped. You can inspect the content of the images via Docker hub (Docker ID account required). The "latest" tag contains the most recent release:
- Microsoft Windows image: https://hub.docker.com/r/castaip/linux_pack/tags?page=1&ordering=last_updated
- Linux image: https://hub.docker.com/r/castaip/linux_pack/tags?page=1&ordering=last_updated
Release Notes
See CAST AIP Docker Installer - Release Notes.
Deployment requirements
Software | Supported | Notes |
---|---|---|
Host Operating System | Microsoft Windows See the Docker Desktop for Windows system requirements: https://docs.docker.com/docker-for-windows/install/#system-requirements
| |
Linux
| ||
Docker | Microsoft Windows Docker Desktop for Windows - latest version recommended, or one that provides:
| |
Linux
| ||
RAM | 16GB RAM (minimum) for the host server. 4GB RAM is granted by default by the CAST AIP Docker Installer to the Docker container running the image - see RAM allocated to the container below. | |
Storage | 25GB (minimum) free storage: SSD with SATA interface recommended. An installation of all components is currently approximately 14GB - however, if your data resides within the Docker container, then you will need additional storage. | |
CAST Storage Service / PostgreSQL instance | The Docker image does not contain a CAST Storage Service/PostgreSQL instance for the analysis data, therefore if you are installing the AIP Node/AIP Core image (Docker for Windows only) you must install an instance on the current server (if the server is powerful enough) or on a dedicated server (recommended). The server on which Docker Desktop is installed and more specifically the container in which AIP Core/AIP Node is deployed, must be able to connect to this CAST Storage Service/PostgreSQL instance. Make sure that the configuration file pg_hba.conf in your CAST Storage Service/PostgreSQL instance is correctly configured to meet this requirement. | |
Access to Docker Hub | The Docker image is hosted on https://hub.docker.com/, therefore the server on which you are performing the installation must have internet access to this URL. |
Installation
See:
- CAST AIP Docker Installer - Microsoft Windows installation
- CAST AIP Docker Installer - Linux installation
Technical information and tips
RAM allocated to the container
The installer will automatically allocate 4GB RAM to the container when the container is started. 4GB is the absolute minimum RAM memory required to run all components. CAST recommends increasing this value. To change the value, you can modify the "4g" entry in the following lines in the installer files:
Microsoft Windows - start_docker_caip.bat: set OPTIONS=-m 4g -t --restart always --name %CAIPCONTAINERNAME% -d Linux - start_docker_caip.sh: ARGS_DOCKER="-m 4g -t --restart always -d --name $CONTAINERNAME -v $DOC_CONF_DIR:/workspace -p $HOSTPORTCONSOLE:8081"
Existing container detected during the installation
If the installer detects an existing container created by CAST in the Docker environment, the installer will prompt whether to remove these existing containers. The default action is to remove all existing containers:
If you choose to retain the existing containers, the installer will choose a new unique container name for the new installation (or you can choose a custom name):
Accessing files within the Docker container
It may be necessary to modify configuration files that reside in the Docker container for certain advanced configuration scenarios. If this is required, you can access the files using the following command from a command or Powershell window, where <container_name> is the name of the container created by the installer in Docker - the default is castcaip_1:
Microsoft Windows: docker exec -it <container_name> cmd Linux: docker exec -it <container_name> /bin/bash