The following are the solution setup prerequisites.
For HA deployment, each machine in the cluster should have the following hardware specifications.
2 cores vCPU
100 GB mounted on /
We require the customer/partner to install the following software on the server.
release 7.7.1908 (Core)
|Administrative privileges (root) are required to follow the deployment steps.|
|Red Hat Enterprise Linux||release 8.4 (Ootpa)||Administrative privileges (root) are required to follow the deployment steps.|
|MS SQL Server 2014, 2016 Express/ Standard/ Enterprise|
Docker Engine Requirements
|IE||Not tested||An on-demand testing cycle can be planned|
Cisco Unified CCE Compatibility
11.6 (Enhanced & Premium)
The Internet should be available on the machine where the application is being installed and connections on port 9242 should be allowed in the network firewall to carry out the installation steps. All the commands start with a # indicating that root user privileges are required to execute these commands. Trailing # is not a part of the command.
Configure Log Rotation
Add the following lines in
/etc/docker/daemon.json file (create the file if not there already) and restart the docker daemon using
systemctl restart docker. Perform this step on all the machines in the cluster in case of HA deployment.
Create a database for UMM and Supervisor Tools services in the MSSQL server with suitable names and follow the application installation steps.
- Download the deployment script supervisor-tools-deployment.sh. This script will:
- delete the supervisor-tools-deployment directory in the present working directory if it exists.
- clone the supervisor-tools-deployment repository from GitLab in the present working directory.
To execute the script, give it the execute permissions and execute it.
# chmod +x supervisor-tools-deployment.sh
- If the customer is not willing to put database password in environment variables file then follow these steps to configure Vault that will hold database password
Update environment variables in the following files inside /
- Get domain/CA signed SSL certificates for SupervisorTools FQDN/CN and place the files in
/root/supervisor-tools-deployment/docker/certificatesfolder. The file names should be
Copy the supervisor-tools-deployment directory to the second machine for HA. Execute below command
# scp -r supervisor-tools-deployment root
- Go to the second machine and update the environment variables where necessary.
Execute the following commands inside /root/supervisor-tools-deployment directory on both machines.
# chmod 755 install.sh
Run the following command to ensure that all the components are up and running. The screenshot below shows a sample response for a standalone non-HA deployment.
# docker ps
Virtual IP configuration
Repeat the following steps for all the machines in the HA cluster.
- Download keepalived.sh script and place it in
Give execute permission and execute the script:
# chmod +x keepalived.sh
Configure keep.env file inside
Pear machine IP.
Virtual IP of the cluster. It should be available in the LAN. For example: 192.168.1.245
Priority of the node. Instance with lower number will have a higher priority. It can take any value from 1-255.
Name of the network interface with which your machine is connected to the network. On CentOS,
ip addr shwill show all the network interfaces and assigned addresses.
Corresponds to the initial startup time of the application in seconds which is being monitored by keepalived. A nominal value of 60-120 is good enough
Do not change this value.
This script is continuously polled after 2 seconds. Keepalived relinquishes control if this shell script returns a non-zero response. It could be either umm or any backend microservice API.
pidof dockerd && wget -O index.html http://localhost:7575/
Update the SERVER_URL variable in environment variables to hold Virtual IP for front-end. Go to microservices table in UMM database, replace the name of tam, prompts and eabc microservices under ip_address column with Virtual IP. Change the ports to corresponding ports exposed in docker-compose file.
- Give the execute permission and execute the script on both machine.
# chmod +x keep-command.sh