Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Purpose

...

Solution Prerequisites

Include Page
Solution PrerequisitesSolution PrerequisitesCompatibility Guide
Compatibility Guide

Installation

  • Place all files provided with therelease 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):

...

DB_URL

URL of the database for the microservice.

For MSSQL:
://<>/<>   

Example:

://192.168.1.92:1433/

://192.168.1.92:1433/

DB_DRIVER

Database driver.

For MSSQL:


DB_DIALECT

Database dialect.


For MSSQL:


DB_USER

Database which has full access on the configured DB

DB_PASS

Database password corresponding to the above user

TZ

configuration. Use the TZ database name for your region from the following URL:

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List

PRIM_IP

IP of the Primary machine in the HA cluster OR IP of the machine

Example:

192.168.1.76

SEC_IP

IP of the Secondary machine in the HA cluster.

Use the same value as of PRIM_IP if not deployed in HA

Example:

192.168.1.80

...

HA Configurations

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

...

KEEPALIVED_UNICAST_PEERS

IP of the other machine in the cluster (cluster means an HA cluster of 2 machines where supervisor tools are being deployed). It shouldn't be the IP of the machine on which you currently areare.

Example:

192.168.1.233

KEEPALIVED_VIRTUAL_IPS

Virtual IP (should be provided by the customer) to be used to access the application. This should be available in the same subnet as the HA machines.

Example:

192.168.1.245

KEEPALIVED_PRIORITY


Priority of the node from 0-255node . A lower number represents a higher priority. The node with higher priority will be master and the other one will be the slave by default.

Example:

100

KEEPALIVED_INTERFACE

The network interface of the machine on which LAN is connectedwhich . On Linux, you can get this by executing $ ip addr sh

On a typical SuSE installation, it would generally bebe:

eth0

CLEARANCE_TIMEOUT

UMM startup time in seconds. On a 2 core machine, UMM takes around 3 minutes or 180 seconds to boot up.

Example:

180

KEEPALIVED_ROUTER_ID

Router ID of the cluster. This should be the same on both the machines in the cluster.

Example:

51

SCRIPT_VAR

This is the health check script. It should remain as is unless you change the umm port in the compose file. Update UMM port instead of 6060 if you’re using some other port. Example:

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

...

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 installedif ).


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.

...

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 but . production certificate files should be provided by the customer


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


 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.

...

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:


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:

...

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

...

  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>

...