.Deployment Guide v13.1

.Deployment Guide v13.1

Solution Prerequisites

Installation Steps

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.

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



Installing Application

  1. Download the deployment script deploy-wallboard.sh and place it in the /root directory. This script will:

    1. delete the wallboard directory in the present working directory if it exists.

    2. clone the wallboard repository from gitlab in the present working directory.

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



  3. Create two databases in your DB server corresponding to wallboard and umm. This step is only required if you're using your own DB server/cluster. If you're using the built in MSSQL database server, you don't need to do anything. 

  4. Update environment variables  in the following files inside /root/wallboard/docker/environment_variables folder.

    1. common-variables.env



    2. umm-variables.env



    3. synchronizer-variables.env



  5. The following configuration must be done at UCCX. This will allow UCCX System to write real-time data to tables that Synchronizer uses to fetch for gadgets.

    1. Go to Tools > “Real Time Snapshot Config” on UCCX Administration UI.

    2. Enable all three checkboxes

    3. Select “5” from dropdown against “Data Writing Interval”

    4. Provide the IP addresses of the machine where Synchronizer will run (comma separated IPs in case of HA, otherwise only one IP) separated by commas in the field against “Server Name” under “Wallboard System.

    5. Click on update button. 

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

  7. Update the translation files inside /root/wallboard/docker/translations folder for multilingual UI. The file names in translation folder should remain unchanged.

  8. Having environment configurations done, copy the wallboard directory on the second machine in/rootdirectory using the following command. 

    # scp -r /root/wallboard root@<machine-ip>:/root/



  9. Having copied the wallboard directory to the second machine, got to /root/wallboard/docker/environment-variables and update INSTANCE_NAME variable in synchronizer-variables.env. Set it to any value other than the value that is set in the first machine. It will differentiate the two VMs as only one synchronizer service will be active. If one goes down, the other starts synchronizing data from UCCE/UCCX.

  10. Execute the following commands inside /root/wallboard directory on both machines.



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

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

  2. Give execute permission and execute the script: 



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



  4. Give the execute permission and execute the script: