Breadcrumbs

Redundant deployment with docker compose

/*<![CDATA[*/ div.rbtoc1769167609721 {padding: 0px;} div.rbtoc1769167609721 ul {list-style: disc;margin-left: 0px;} div.rbtoc1769167609721 li {margin-left: 0px;padding-left: 0px;} /*]]>*/ Solution Prerequisites Hardware Sizing Software Requirements OS Compatibility Database Requirements Docker Engine Requirements Browser Compatibility Cisco Unified CCX Compatibility Cisco Unified CCE Compatibility Wallboard Reporting/ Display Device Port Utilization System Access Requirements Deployment Privileges Provision Database and a user on SQL Server Cluster Integration with UCCX Integration with UCCE Time Synchronization Requirements Installation Steps Configure Log Rotation Installing Application Virtual IP configuration (Only for HA deployment) Adding License Uninstalling Troubleshooting

Solution Prerequisites

[data-colorid=edq04qwil7]{color:#434343} html[data-color-mode=dark] [data-colorid=edq04qwil7]{color:#bcbcbc}[data-colorid=tf976gllpw]{color:#303f9f} html[data-color-mode=dark] [data-colorid=tf976gllpw]{color:#606fcf}[data-colorid=imr5wwxcxo]{color:#303f9f} html[data-color-mode=dark] [data-colorid=imr5wwxcxo]{color:#606fcf}[data-colorid=re956ygkyk]{color:#303f9f} html[data-color-mode=dark] [data-colorid=re956ygkyk]{color:#606fcf}[data-colorid=rpzs0zszk9]{color:#434343} html[data-color-mode=dark] [data-colorid=rpzs0zszk9]{color:#bcbcbc}[data-colorid=orfl89epec]{color:#303f9f} html[data-color-mode=dark] [data-colorid=orfl89epec]{color:#606fcf}[data-colorid=n9u37g76ox]{color:#303f9f} html[data-color-mode=dark] [data-colorid=n9u37g76ox]{color:#606fcf}[data-colorid=us653xa1j7]{color:#303f9f} html[data-color-mode=dark] [data-colorid=us653xa1j7]{color:#606fcf}[data-colorid=v91juy28rk]{color:#303f9f} html[data-color-mode=dark] [data-colorid=v91juy28rk]{color:#606fcf}[data-colorid=t99xei0jkv]{color:#303f9f} html[data-color-mode=dark] [data-colorid=t99xei0jkv]{color:#606fcf}[data-colorid=qw74vcv6zc]{color:#434343} html[data-color-mode=dark] [data-colorid=qw74vcv6zc]{color:#bcbcbc}[data-colorid=lgk5z4ag3w]{color:#303f9f} html[data-color-mode=dark] [data-colorid=lgk5z4ag3w]{color:#606fcf}[data-colorid=w0vrkgam8s]{color:#434343} html[data-color-mode=dark] [data-colorid=w0vrkgam8s]{color:#bcbcbc}[data-colorid=p6ei7rqmm3]{color:#303f9f} html[data-color-mode=dark] [data-colorid=p6ei7rqmm3]{color:#606fcf}[data-colorid=ukxvl3z7vb]{color:#303f9f} html[data-color-mode=dark] [data-colorid=ukxvl3z7vb]{color:#606fcf}[data-colorid=a7iiews9lb]{color:#434343} html[data-color-mode=dark] [data-colorid=a7iiews9lb]{color:#bcbcbc}[data-colorid=geq6gcyp9s]{color:#434343} html[data-color-mode=dark] [data-colorid=geq6gcyp9s]{color:#bcbcbc}[data-colorid=twrtv7uw4j]{color:#434343} html[data-color-mode=dark] [data-colorid=twrtv7uw4j]{color:#bcbcbc}[data-colorid=qyxhsoubli]{color:#303f9f} html[data-color-mode=dark] [data-colorid=qyxhsoubli]{color:#606fcf}[data-colorid=v5vvw5nxwh]{color:#303f9f} html[data-color-mode=dark] [data-colorid=v5vvw5nxwh]{color:#606fcf}[data-colorid=x8nawj6j7d]{color:#3a3a40} html[data-color-mode=dark] [data-colorid=x8nawj6j7d]{color:#bfbfc5}[data-colorid=i0iqz4siia]{color:#434343} html[data-color-mode=dark] [data-colorid=i0iqz4siia]{color:#bcbcbc}[data-colorid=b8gt743whj]{color:#303f9f} html[data-color-mode=dark] [data-colorid=b8gt743whj]{color:#606fcf}[data-colorid=yos0440b3r]{color:#303f9f} html[data-color-mode=dark] [data-colorid=yos0440b3r]{color:#606fcf}[data-colorid=icecly7fwu]{color:#303f9f} html[data-color-mode=dark] [data-colorid=icecly7fwu]{color:#606fcf}[data-colorid=o7vpg98ilx]{color:#434343} html[data-color-mode=dark] [data-colorid=o7vpg98ilx]{color:#bcbcbc}[data-colorid=s3p9wmbbzk]{color:#303942} html[data-color-mode=dark] [data-colorid=s3p9wmbbzk]{color:#bdc6cf}[data-colorid=c3a8gvmes3]{color:#303f9f} html[data-color-mode=dark] [data-colorid=c3a8gvmes3]{color:#606fcf}[data-colorid=jomlxt1efn]{color:#434343} html[data-color-mode=dark] [data-colorid=jomlxt1efn]{color:#bcbcbc}[data-colorid=ilf96q41k6]{color:#33444c} html[data-color-mode=dark] [data-colorid=ilf96q41k6]{color:#b3c4cc}[data-colorid=rvc72em8qt]{color:#434343} html[data-color-mode=dark] [data-colorid=rvc72em8qt]{color:#bcbcbc}[data-colorid=d4xpd05sf9]{color:#434343} html[data-color-mode=dark] [data-colorid=d4xpd05sf9]{color:#bcbcbc}[data-colorid=kacq98b0o2]{color:#434343} html[data-color-mode=dark] [data-colorid=kacq98b0o2]{color:#bcbcbc}[data-colorid=qsaz11tnm9]{color:#434343} html[data-color-mode=dark] [data-colorid=qsaz11tnm9]{color:#bcbcbc}[data-colorid=zp46d9dn08]{color:#303f9f} html[data-color-mode=dark] [data-colorid=zp46d9dn08]{color:#606fcf}[data-colorid=aod8aoet4q]{color:#3a3a40} html[data-color-mode=dark] [data-colorid=aod8aoet4q]{color:#bfbfc5}[data-colorid=okqn7ylc7o]{color:#434343} html[data-color-mode=dark] [data-colorid=okqn7ylc7o]{color:#bcbcbc}[data-colorid=rooo2enarg]{color:#434343} html[data-color-mode=dark] [data-colorid=rooo2enarg]{color:#bcbcbc}[data-colorid=ncasb0ixa4]{color:#303f9f} html[data-color-mode=dark] [data-colorid=ncasb0ixa4]{color:#606fcf}[data-colorid=vfuq9mpagd]{color:#303f9f} html[data-color-mode=dark] [data-colorid=vfuq9mpagd]{color:#606fcf}Hardware SizingThe following lists the machine specifications for up to 100 concurrent agents deployment, with no other EF components installed on the VM.vCPUvRAMvDiskNotes2 cores (2.60GHz, 2 processors)4 GB1x100 GB mounted on /In case MSSQL server is installed on a separate machine4 cores (2.60 GHz, 4 processors8 GB1x100 GB mounted on /If MSSQL server is installed on the same machine as the wallboard stackFor HA, the same specifications would be doubled for two machines.To get machine specifications for a larger agent volume and/or with other ExpertFlow products in a co-resident deployment, please get a quote from ExpertFlow or contact your ExpertFlow Account Manager.Software RequirementsOS CompatibilityThe following OS software is required on the server:ItemVersionNotesCentOS7.x updated to the latest packages (use Yum update)Administrative privileges (root) are required to follow the deployment steps.Database RequirementsItemNotesMS SQL Database Server 2016/2017 Express/Standard/EnterpriseFor clustered SQL Server installation, the customer will be responsible to provide the cluster. For stand-alone DB deployment, DB (2017 express) will be included within docker containers.Microsoft SQL Server 2017Microsoft SQL Server 2017, Microsoft Corporation Express Edition (64-bit) on Linux (Ubuntu 16.04.5 LTS). Only valid in case of a non-HA deployment.Docker Engine RequirementsItemNotesDocker CEDocker CE 18.06.0+Browser CompatibilityItemVersionNotesFirefox73.0.1 (64-bit)ChromeNot tested Some UI elements might not render properly. A full-blown testing cycle can be carried out on demand.IENot testedNot supportedCisco Unified CCX Compatibility Tested with the CCX version 11.5 and 11.6 Assumed to work on higher versions as well. An on-demand testing cycle can also be executed on older versions of CCX.Cisco Unified CCE CompatibilityTested with the CCE version 11.5. Assumed to work on higher versions as well. An on-demand testing cycle can also be executed on older versions of CCE.Wallboard Reporting/ Display DeviceThe provisioning of reporting devices is partner/customer's responsibility. For reporting device, one of the following hardware solutions must be provided to display wallboard views in the production environment.An existing PC with a pre-installed OS, Monitor or LCD for wallboard display ORA Smart LCD with an embedded browser to open the wallboard view ORA raspberry pi device with OS installed with an LCD to display.For raspberry pi device's details, see https://www.raspberrypi.org/products/raspberry-pi-3-model-b/Port UtilizationThe following ports should remain open on the Firewall. The local security policy and any antivirus should also allow open communication on the following ports.TypeSource HostSource PortDestination HostDestination PortHTTPEnterprise web useranyDashboard & Wallboards80HTTPSDashboards & Wallboards serveranyDashboard & Wallboards443UDP/TCPDashboards & Wallboards serveranyMS SQL Server (CCE DB)1433System Access RequirementsDeployment PrivilegesAdministrative privileges (root) on the machine are required to follow the deployment 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.Provision Database and a user on SQL Server ClusterThe following database and the privileged SQL user is required to connect to the application database. The application will create its tables and other schema objects itself after connection. Create a wallboard application database with the name EFWallboard.Create an SQL Server User EFUser with a database role db_owner on the EFWallboard database.Integration with UCCXTo read CSQs and agents list from CCX, we need admin user credentials to access UCCX Configuration APIs to fetch the list of CSQs, agents, and teams.To access the Cisco CCX database remotely via the wallboard application, CCX reporting user (uccxhruser) password is required.Integration with UCCE Since we need access on the Cisco AW database remotely, create an SQL server user, EFUser, with db_datareader role on the Cisco AW database.Time Synchronization RequirementsIf the system dates and times are not synchronized, the system can produce unpredictable results. Therefore, the EF applications and Cisco Contact Center should have their time zone and date/time properly configured, according to the geographic region and must be synchronized.To configure the time zone, please see the instructions from the hardware or software manufacturer of the NTP server. The application servers should be synchronized. This synchronization should be maintained continuously and validated on a regular basis. For security reasons, the Network Time Protocol (NTP) V 4.1+ is recommended.

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.

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. 

    # chmod +x deploy-wallboard.sh
    # ./deploy-wallboard.sh


  3. Create two databases in your DB server corresponding to the 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

      Name

      Description

      Do not change the default values for non-HA deployment OR if you want to use the built-in database. For HA, use SQL server cluster settings instead of the defaults. If you want to use your own MSSQL instance anyway, update the following variables accordingly.

      DB_URL

      Wallboard database connection url

      For example:

      • jdbc:jtds:sqlserver://<MACHINE-IP or FQDN>:PORT/db_name

      • jdbc:jtds:sqlserver://<MACHINE-IP or FQDN>:PORT/db_name;instanceName=SomeInstance

      DB_USER

      database user

      DB_PASSWORD

      database password

      DB_DRIVER

      JDBC driver e.g., net.sourceforge.jtds.jdbc.Driver

      DB_DIALECT

      Database dialect e.g., org.hibernate.dialect.SQLServer2008Dialect

      CISCO_TYPE

      The cisco type of solution .It is either "uccx" or "ucce"

      SSO_ENABLED

      Single sign on facility, its value is either "true" or "false"


    2. umm-variables.env

      Name

      Description

      Do not change the default values for non-HA deployment OR if you want to use the built-in database. For HA, use SQL server cluster settings instead of the defaults. If you want to use your own MSSQL instance anyway, update the following variables accordingly.

      DB_URL

      UMM  database connection URL

      For example:

      • jdbc:jtds:sqlserver://<MACHINE-IP or FQDN>:PORT/db_name

      • jdbc:jtds:sqlserver://<MACHINE-IP or FQDN>:PORT/db_name;instanceName=SomeInstance

      DB_USER

      database user

      DB_PASS

      database password

      DB_DRIVER

      JDBC driver e.g., net.sourceforge.jtds.jdbc.Driver

      DB_DIALECT

      Database dialect e.g., org.hibernate.dialect.SQLServer2008Dialect

      REDIRECT_BASE_URL

      Callback URL for Wallboard.. The format would be: https://wallboard-ip/callback

      IDS1_URL

      Provide the base URI of UCCE/UCCX node. The format would be: https://<fully qualified hostname of UCCX publisher node>:8553

      IDS2_URL

      If UCCE/UCCX is deployed in High Availability mode, provide the base URI of the second node. The format would be: https://<fully qualified hostname of UCCX Subscriber node>:8553

      IDS_CLIENT_ID

      Register supervisor tools application in IDS to get client ID by following the steps

      here

      . Example:
      973a8f41be45426510c971ce41b6feae8d71bc22

      UMM_BASE_URL

      UMM base URL. It should be: https://IP:umm-port

      Change the following variables as per your environment

      PRIM_FINESSE_IP

      Primary Finesse URL including port (if not 80 or 443)

      For example:

      SEC_FINESSE_IP

      Secondary Finesse URL including port (if not 80 or 443)

      For example:

      FINESSE_USER

      Finesse administrator user

      FINESSE_PASS

      Finesse administrator password

      SSO_ENABLED

      The single sign-on facility, its value is either "true" or "false"


    3. synchronizer-variables.env

      Name

      Description

      CC_TYPE

      Decides whether Cisco contact center is UCCX or UCCE

      Holds string "UCCX" for UCCX and "UCCE" for UCCE. Default is UCCX

      REDUNDANT_DEPLOYMENT

      Decides if synchronizer deployment is redundant. Set it to "true". Holds strings "true" or "false". Default is false 

      INSTANCE_NAME

      Used for differentiation of instances when deployed redundant, could be any string. It should be different on both machines.

      SYNC_AGENTS

      To enable Agent sync set it to "true", default is true

      SYNC_AGENTS_STATS

      Enables/disables agents stats sync, default is true

      SYNC_AGENTS_EMAIL_STATS

      Enables/disables agent email stats, default is false

      SYNC_QUEUES_STATS

      Enables/disables queue stats, default is true

      SYNC_QUEUES

      Enables/disables queues/skillgroups in case of UCCE, default is true

      Following variables are used when CC_TYPE = "UCCX"

      UCCX_PUB_IP

      Primary UCCX IP

      UCCX_PUB_USERNAME

      Primary UCCX admin username

      UCCX_PUB_PASSWORD

      Primary UCCX admin password

      UCCX_SUB_USERNAME

      Secondary UCCX admin username

      UCCX_SUB_PASSWORD

      Secondary UCCX admin password

      UCCX_PUB_DB_PASSWORD

      Primary UCCX database reporting user (hruser) password

      UCCX_SUB_DB_PASSWORD

      Secondary UCCX database reporting user (hruser) password

      UCCX_REAL_TIME_PORT

      UCCX real-time APIs port, default is 9080

      Following variables are used when CC_TYPE = "UCCE"

      CCE_DB_URL

      UCCE awdb database URL

      jdbc:jtds:sqlserver://192.168.1.87:1433/ucce_awdb

      CCE_DB_USER

      CCE database user

      CCE_DB_PASSWORD

      CCE database password

      TZ

      The timezone of UCCE e.g. Asia/Karachi   


  5. The following configuration must be done at UCCX. This will allow the UCCX System to write real-time data to tables that Synchronizer uses to fetch for gadgets. This step is not needed for UCCE deployments.Go to Tools > “Real-Time Snapshot Config” on UCCX Administration UI.Enable all three checkboxesSelect “5” from dropdown against “Data Writing Interval”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 the "Wallboard System".Click on the 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 the translation folder should remain unchanged.

  8. Having environment configurations done, copy the wallboard directory on the second machine in/root directory using the following command. (Only for HA deployment)

    # 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 the 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. (Only for HA deployment)

  10. Execute the following commands inside /root/wallboard directory on both machines (if in HA, otherwise on the only machine in the cluster).

    # chmod 755 install.sh
    # ./install.sh


  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. 

    # docker ps

    wallboard2.png

Virtual IP configuration (Only for HA deployment)

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: 

    # chmod +x keepalived.sh
    # ./keepalived.sh


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

    Name

    Description

    KEEPALIVED_UNICAST_PEERS

    IPs of the machines in the cluster. On each machine, this variable should have a list of IPs of all the other machines in the cluster. The format of the list is as below: 

    "#PYTHON2BASH:['192.168.1.76','192.168.1.80']" 

    KEEPALIVED_VIRTUAL_IPS

    Virtual IP of the cluster. It should be available in the LAN. For example: 192.168.1.245

    KEEPALIVED_PRIORITY

    The priority of the node. Instances with lower numbers will have a higher priority. It can take any value from 1-255. 

    KEEPALIVED_INTERFACE

    Name of the network interface with which your machine is connected to the network. On CentOS, ifconfig or ip addr sh will show all the network interfaces and assigned addresses. 

    CLEARANCE_TIMEOUT

    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

    KEEPALIVED_ROUTER_ID

    Do not change this value.

    SCRIPT_VAR

    This script is continuously polled after 2 seconds. Keepalived relinquishes control if this shell script returns a non-zero response. For wallboard, it should be:

    pidof dockerd && wget -O index.html http://localhost/umm/base/index.html


  4. Give the execute permission and execute the script: 

    # chmod +x keep-command.sh
    # ./keep-command.sh


Adding License

  1. Browse to https://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. 
    Screenshot 2019-09-07 at 1.43.47 AM.png

  3. Go to https://FQDN to access wallboard front-end. (FQDN will be the domain name assigned to the VIP).

  4. Go to Data Service on the left side menu to define data services. There will be two data services named Agent Service and Queue Service with the following URLs.

        https://FQDN/agent-service and https://FQDN/queue-service 

              data.png


Uninstalling

To uninstall the application completely, execute the following commands.

# docker-compose -f /root/wallboard/docker/docker-compose.yml down
# docker rm -f keep-alived
# docker system prune
# docker network prune


Troubleshooting

  • To update any changes in the environment variables and/or compose file, simply execute the install script again:

    /root/wallboard/install.sh


  • To restart the whole stack completely, execute the following commands: 

    # docker-compose -f /root/wallboard/docker/docker-compose.yml down
    # /root/wallboard/install.sh