Run the installer
Run the Linux installer script with the following command:
./start_docker_dashboards.sh
Choose simple or advanced installation
The installer will run and offer you a choice between simple or advanced install mode:
| Simple mode |
In this scenario, all items are installed within the Docker environment. Access is granted to the Dashboards outside the Docker environment via a predefined 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:
|
Simple mode
Choosing simple mode will require you to input additional details to define:
- the parameters of your CAST Storage Service/PostgreSQL instance on which the AIP schemas you want to use with the CAST Dashboards are stored
- the name of your Measure schema
- the names of your Dashboard schemas
- the license key for access to the Dashboard schemas
CAST Storage Service/PostgreSQL parameters
| hostname | Enter the hostname/IP address and port number of the CAST Storage Service/PostgreSQL instance on which the AIP schemas are stored. This CAST Storage Service/PostgreSQL instance can either be installed on the local server or a remote server. hostname must not be localhost even if the CAST Storage Service/PostgreSQL instance is located on the same server as your Docker installation. Keep in mind that a Docker container is a standalone package of software, similar to a lightweight virtual machine. Thus, using localhost will be seen by the container as a server hosted within the container itself and not as the server on which Docker is installed. |
|---|---|
| port | |
| user | Enter the credentials for the CAST Storage Service/PostrgreSQL instance. The default options are operator/CastAIP. |
| password |
Additional details
| Name of your Measure schema | Enter the name of your Measure schema that will be used by the Health Dashboard. |
|---|---|
| Names of your Dashboard schemas | Enter name(s) of your Dashboard schemas for use with the Engineering or Security Dashboard. If you have multiple schemas to use, enter them separated by a comma, for example:
|
| License key for access to the Dashboard schemas | Enter the license key for access to your Dashboard schemas via the Engineering or Security Dashboard. See Dashboard Service license key configuration. |
In a new installation, no existing containers will be detected, and the installer will then create a new Docker container with the default name castdashboards_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 be prompted to select
- the Dashboards that you want to start and choose their port numbers
- the parameters of your CAST Storage Service/PostgreSQL instance on which the AIP schemas you want to use with the CAST Dashboards are stored
Dashboard and port number selection
| Health and Engineering Dashboard | Choose to install both the Health and Engineering Dashboard as a "combined" installation. The default port number will be set to 8080, but you can choose another custom port if required. |
|---|---|
| Health Dashboard | Choose to install the Health Dashboard alone. The default port number will be set to 8081, but you can choose another custom port if required. |
| Engineering Dashboard | Choose to install the Engineering Dashboard alone. The default port number will be set to 8082, but you can choose another custom port if required. |
| Security Dashboard | Choose to install the Security Dashboard alone. The default port number will be set to 8083, but you can choose another custom port if required. |
CAST Storage Service/PostgreSQL parameters
| hostname | Enter the hostname/IP address and port number of the CAST Storage Service/PostgreSQL instance on which the AIP schemas are stored. This CAST Storage Service/PostgreSQL instance can either be installed on the local server or a remote server. hostname must not be localhost even if the CAST Storage Service/PostgreSQL instance is located on the same server as your Docker installation. Keep in mind that a Docker container is a standalone package of software, similar to a lightweight virtual machine. Thus, using localhost will be seen by the container as a server hosted within the container itself and not as the server on which Docker is installed. |
|---|---|
| port | |
| user | Enter the credentials for the CAST Storage Service/PostrgreSQL instance. The default options are operator/CastAIP. |
| password |
Additional details
| Name of your Measure schema | Enter the name of your Measure schema that will be used by the Health Dashboard - if you have chosen to install it. |
|---|---|
| Names of your Dashboard schemas | Enter name(s) of your Dashboard schemas for use with the Engineering or Security Dashboard - if you have chosen to install them. If you have multiple schemas to use, enter them separated by a comma, for example:
|
| License key for access to the Dashboard schemas | Enter the license key for access to your Dashboard schemas via the Engineering or Security Dashboard. See Dashboard Service license key configuration. |
Data persistence requirements
Finally you will be prompted to choose whether you want to keep the data generated by the CAST Dashboards (logs etc.) within the container (hit Enter), or in a specific location on the server (enter a "root" folder that will be used for the CAST AIP data, for example /var/opt/cast/dashboards/ (this path must NOT exist already)):
In a new installation, no existing containers will be detected, and the installer will then create a new Docker container with the default name castdashboards_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/.
Check summary
When the image is up and running, a summary of the installation process will be displayed on screen:
Click to enlarge
Check container and image
Run the following command to check that the image is up and running:
docker ps
Test Dashboard access
When the deployment is complete and depending on the installation choices you made, you should test that you can access the deployed Dashboards, preferably from another server/workstation on the network. The URLs and logins for each Dashboard are provided in the summary (shown above), but if you used the default settings, you can access the Dashboards as follows:
- http://<host_server>:8080
- http://<host_server>:8081/portal/index.html
- http://<host_server>:8082/engineering/index.html
- http://<host_server>:8083/security/index.html
Default configuration
All Dashboards are deployed with the following settings:
| Authentication | Local authentication is enabled with one single user "admin" with the following credentials:
|
|---|---|
| Roles | The single user admin is granted the role ADMIN. |
| Authorization | The ADMIN user will have access to all applications across all dashboards. |
Modifying the default configuration
If you would like to modify the default configuration for example, change the authentication method, configure roles, configure authorizations etc. the method you use depends on the installation choices you have made. See below. You can refer to the following documentation for more information about the options available:
f you make any changes, restart the container to ensure the changes are taken into account.
docker restart <my_container_id>
Simple mode choice
In simple mode, all configuration files are located within the container, therefore you will need to access them as follows where <container_name> is the name of the container created by the installer in Docker - the default is castdashboards_1:
docker exec -it <container_name> /bin/bash
For example:
docker exec -it castdashboards_1 /bin/bash
You will find the configuration files for each dashboard in the /cast sub-folder:
Then each dashboard is located in its own folder:
- engineering
- health
- health_engineering
- security
Use your favourite editor to configure the file you need:
Finally, to exit the container and return to your local console, just enter exit. If you have made any changes, restart the container.
Advanced mode choice with data stored outside the container
If you chose to store the data outside the container in advanced mode, you can edit the file with your favourite editor, save and then restart the container if you have made any changes.
