Document toolboxDocument toolbox

Deployment Guide

Owned by Sikander Hayat
Last updated: Mar 25, 2024 by QA Team
3 min read

Solution Prerequisites

 

Installation Steps

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.

Allow ports in the firewall

For internal communication of the docker swarm, you'll need to allow communication (both inbound and outbound) on the ports: 8083/tcp,8084/tcp , 8085/tcp, 8086/tcp, 8087/tcp, 8844/tcp, 8834/tcp, 8443/tcp and 443/tcp.

To start the firewall on CentOS (if it isn't started already), execute the following commands. You'll have to execute these commands on all the cluster machines.: 

systemctl enable firewalld systemctl start firewalld

To allow the ports on CentOS firewall, you can execute the following commands. You'll have to execute these commands on all the cluster machines.

firewall-cmd --add-port=8083/tcp --permanent firewall-cmd --add-port=8084/tcp --permanent firewall-cmd --add-port=8085/tcp --permanent firewall-cmd --add-port=8086/tcp --permanent firewall-cmd --add-port=8087/tcp --permanent firewall-cmd --add-port=8844/tcp --permanent firewall-cmd --add-port=8834/tcp --permanent firewall-cmd --add-port=8443/tcp --permanent firewall-cmd --add-port=443/tcp --permanent firewall-cmd --reload

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.

{ "log-driver": "json-file", "log-opts": { "max-size": "50m", "max-file": "3" } }

Creating Databases

Create a database for UMM and Supervisor Tools services in the MSSQL server with suitable names and follow the application installation steps.

Installing Application

  1. Download the deployment script . This script will:

    1. delete the supervisor-tools-deployment directory in the present working directory if it exists.

    2. clone the supervisor-tools-deployment repository from GitLab in the present working directory.

  2. To execute the script, give it the execute permissions and execute it. 

  3. For UCCE customers only, execute the following command

  4. For UCCX customers only, uncomment the lines 71 - 81 from file /root/supervisor-tools-deployment/docker/docker-compose.yml

    It should looks like

  5. Update environment variables  in the following files inside /supervisor-tools-deployment/docker/environment_variables folder.

    1. Update UMM environment variables in the umm-environment-variables.env file.

    2. Update Supervisor Tools Environment variables in the environment-variables.env. See also, Caller Lists Environment Variables to specify variables of the Caller Lists microservice.

  6. Get domain/CA signed SSL certificates for SupervisorTools FQDN/CN and place the files in /root/supervisor-tools-deployment/docker/certificates folder. The file names should be server.crt and server.key.

  7. Copy the supervisor-tools-deployment directory to the second machine for HA. Execute below command 

  8. Go to the second machine and update the environment variables where necessary.

  9. Execute the following commands inside /root/supervisor-tools-deployment directory on both machines.

  10. 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. 

     

Note: All machines and virtual IP should be on the same subnet for HA testing.

Virtual IP configuration

Repeat the following steps for all the machines in the HA cluster.

  1. Download keepalived.sh script and place it in /root the directory.

  2. Give execute permission and execute the script: 

  3. Configure keep.env file inside /root/keep-alived folder

  4.  Update the SERVER_URL in /supervisor-tools-deployment/docker/environment_variables to hold Virtual IP for front-end.

  5. Give the execute permission and execute the script on both machine.

Finesse Gadget Deployment

SMBv2 Commands:

Following are the commands to enable and disable SMBv1 and SMBv2 on the SMB server component.

  1. Detect if SMB1 enabled
    Get-SmbServerConfiguration | Select EnableSMB1Protocol

  2. Enable SMB1
    Set-SmbServerConfiguration -EnableSMB1Protocol $true

  3. Disable SMB1
    Set-SmbServerConfiguration -EnableSMB1Protocol $false

  4. Detect if SMB2 enabled
    Get-SmbServerConfiguration | Select EnableSMB2Protocol

  5. Enable SMB2
    Set-SmbServerConfiguration -EnableSMB2Protocol $true

  6. Disable SMB2
    Set-SmbServerConfiguration -EnableSMB2Protocol $false

For more info you can check:https://learn.microsoft.com/en-us/windows-server/storage/file-server/troubleshoot/detect-enable-and-disable-smbv1-v2-v3?tabs=server

Adding License

  1. Browse to http://<MACHINE_IP or FQDN>/umm in your browser (FQDN will be the domain name assigned to the IP/VIP). 

  2. Click on the red warning icon on right, paste the license in the field and click save.