Deployment Guide version 12.3

Purpose

To provide installation prerequisites, system requirements and installation instructions of supervisor tools.

Solution Prerequisites

Installation

• Place all files provided with the release in any folder (preferably /root) on all the machines where the application is being deployed.

• Go to the folder where you copied all the tar files and load them in running following command (the command starts after $ sign):

$ for file in *.tar; load < $file; done  

Configurations

Application Configurations

Create new DBs in the MSSQL server with any names corresponding to all in the -compose file. Update the configurations in the compose file (values under environment tag in each service). below:

Generic configurations in all services:

UMM-specific configurations:

the above configurations, in UMM service in the compose file.

HA Configurations

Edit the keep.env file to configure the HA attributes. The following table describes the details.

Firewall Configuration

You must allow all the ports corresponding to services in the compose file for HTTP and HTTPS for both external and internal network zones. By default, we’d have 8080-8084 (HTTP), 8443-8444 (HTTPS) ports and port 27017 (if MongoDB is installed).

On CentOS 7, you can execute the following commands to enable the default ports in public zone:

$ firewall-cmd --zone=public --add-port=8080-8084/tcp --permanent

$ firewall-cmd --zone=public --add-port=8443-8444/tcp --permanent

$ firewall-cmd --zone=public --add-port=27017/tcp --permanent

$ firewall-cmd --reload

Consult network admin for SLES.

SSL Configuration

To configure SSL/TLS in your application, place your certificate and key files (names should be server.crtserver.crt and server.key) in a directory on root and mount a volume corresponding to that directory inside UMM container. A default self-signed certificate has been added in the build, but the production certificate files should be provided by the customer. been addedthe production certificate files should be provided by the customer

For example, if you place your SSL files in /root/SSL, you should update umm part in the eabc-compose.yml file as below:you should ummeabc.yml

 umm:

   image: umm:12.1.11

   ...               #All the configurations would remain the same

   volumes:

     - /root/ssl:/usr/local/tomcat/webapps/umm/base/https

Do NOT make the above changes if you want to use the default self-signed certificate for the server.

Translations

For Supervisor Tools

Download this folder, update the translations in it in the respective JSON files and place it in the root directory of the machine (all the machines if deploying in HA).  The following files refer to their corresponding languages as below:

• en.json: English

• fr.json: French

• gr.json: German

• it.json: Italian

The translation folder should have the following hierarchy:

• translations

• Announcement

• i18n

• en.json

• fr.json

• gr.json

• it.json

• Base

• i18n

• en.json

• fr.json

• gr.json

• it.json

After updating and placing translations folder, mount the following volume in umm service in the eabc-compose.yml file:

volumes:

• /root/translations:/usr/local/tomcat/webapps/umm/base/translations

For CIM (if installed)

Download this folder, update the translations in it in the respective JSON files and place it in the root directory of the machine (all the machines if deploying in HA).  The following files refer to their corresponding languages as below:

• en.json: English

• fr.json: French

• gr.json: German

• it.json: Italian

The translation folder should have the following hierarchy:

• translations-cim

• i18n

• en.json

• fr.json

• gr.json

• it.json

After updating and placing translations-cim folder, mount the following volume in umm service in the eabc-compose.yml file:

volumes:

• /root/translations-cim:/usr/local/tomcat/webapps/umm/base/cim/ui/app/main/apps/CIM

Log Rotation

Add the following lines in daemon.json file in /etc/docker/ directory (create the file with the name daemon.json in /etc/docker/ if it isn’t there already) and restart the docker daemon using systemctl restart docker on all machines. Following configuration sets a maximum of three log files with max size for each file as 20 MBs.

{ "log-driver": "json-file",

"log-opts": {

"max-size": "20m",

"max-file": "3"

}

}

Execution

CentOS

• Start the HA cluster on all the machines with the following command:

$ chmod +x keep-command.sh && ./keep-command.sh

• Start the compose service on all machines using the following command:

$ docker-compose -f eabc-compose.yml up -d

SLES

• Start a swarm cluster on the machine if you haven’t done that already (for some other application stack) with the following command:

$ docker swarm init

• Start the HA cluster on all the machines with the following command:

$ chmod +x keep-command.sh && ./keep-command.sh

• Start the compose service on all machines using the following command:

$ docker stack deploy -c eabc-compose.yml st

If everything goes well, you should be able to access the application on http://Virtual-IP:8080/umm OR https://Virtual-IP:8443/umm after the application boot time (takes around 3 minutes on a 2 core machine).

With non-redundant (non-HA) deployment, the access URL will have physical machine IP instead of the virtual IP.

Gadget Deployment

1. Download the latest gadget’s specifications files from here and extract files on the desired directory.

2. Open the EFGadget.js file and update the URL with your virtual-IP and port of umm service as per your deployment on line 64 as below:

   
   

3. Run FileZilla or any other FTP client and log in to finesse using following credentials

   1. Host: IP of the finesse where gadget is deployed

   2. Username: 3rdpartygadget  

   3. Password: ask the Finesse administrator for the password

   4. port: 22

4. Create a folder e.g. EFGadget into the files directory on finesse server and upload the specifications files on finesse server.

5. Repeat the same steps for deploying the gadget on the secondary Finesse server.

6. Open cfadmin for your finesse using https://finesse.ip:8445/cfadmin, login and follow the steps below to add the supervisor tools gadget in your team:

   1. Click on Team Resources tab on top

   2. Click on the team for which you want to add the gadget

   3. Scroll down the “Desktop Layout XML” part at the bottom of the screen and locate <role>supervisor</role> and add the following line after the <tabs> tag.

      <tab>

                  <id>ST</id>

                  <label>Supervisor Tools</label>

                  <columns>

                      <column>

                          <gadgets>

                              <gadget>/3rdpartygadget/files/<folder>/EFGadget.xml</gadget>

                          </gadgets>

                      </column>

                  </columns>

              </tab>
   

See the following screenshot.

Troubleshooting

Logs for each container are available in files as well as within docker daemon. To see the logs for any container on STDOUT, execute docker ps and get the id of the container. Use that id to see the logs using docker logs <container_id>.

At any given time, the active machine would be the one with highest keepalived priority, so the logs would be stored there. You can also see the active machine in case of HA using keepalived logs.