Setup Load Balancing For Multiple LQEs on a JAS Based Deployment

The following article is an example of how you can configure Multiple Lifecycle Query Engine (LQE) Nodes, deployed with Jazz Authorization Server, with Load Balancing for Distributing query workload.

This examples assumes the ELM deployment is on IBM WebSphere Liberty Profile with Jazz Authorization Server enabled and a Reverse Proxy Server (IBM HTTP Server).

High Level Instructions

Pre-Req: LQE deployed on its own IBM Liberty server and is setup with a distributed deployment of ELM enabled with JAS.

• Run a Backup on the Primary LQE Server
• Install and configure an additional LQE node
• Add the new node URIs to JAS LQE registration
• Test Individual LQE Nodes and change Node Names
• Setup Apache HTTP Server or HAProxy as Load Balancer for the LQE nodes
• Reconfigure LQE redirection in Reverse Proxy to point to the Load Balancer
• Test Load Balanced LQE setup

Run a Backup on the Primary LQE Server

You will need a backup from your original LQE server to configure additional servers. A backup contains all the metadata in LQE and a copy of the indexed data. You can use the backup files to install another LQE server that has a copy of the indexed data.

• To create a One Time Backup see Backing up and restoring Lifecycle Query Engine
• Or if Backups are scheduled, review the backup location
• Copy over the latest backup to the new server identified for the second or additional LQE Node
• In addition Copy the lqe.key, lqe.node.id and dbconnection.properties files from the conf/lqe directory to the new server

Install and Configure additional LQE node

• Install LQE on a new application server. You do not need to install a new Jazz Team Server.
• Create a new relational database for the new LQE server, Click for Instructions
• Copy the following folders from the LQE backup to the new installation:
  • Copy the /datasets directory into the conf/lqe directory in the new installation.
  • Copy the /metadata directory into the conf/lqe directory in the new installation.
• Copy the lqe.key, lqe.node.id and dbconnection.properties files from the original server to the conf/lqe directory in the new installation
• Edit dbconnection.properties file in the conf/lqe directory and update the db.location and db.password
• Edit lqe.properties file in the conf/lqe directory and set the LQE restore property to true:

  lqe.restore=true

• Edit [LQE_HOME]/server/server.startup file to update any of the required configurations like Java Heap memory allocation to match the primary server
• Edit [LQE_HOME]/server/liberty/servers/clm/server.xml file to add clone Id to httpSession element as show below

  <httpSession invalidateOnUnauthorizedSessionRequestException="true" cookieSecure="true" cloneId="lqenode2"/>

• Start the new LQE Node

Update JAS Registration with new LQE Node URL

We have included scripts to add new URLs to JAS registrations which is primarily used for setting up clustering. We can reuse these scripts for this task.

On the LQE Server

• Directory - [LQE_HOME]/server/clustering
• Copy over the files addNodeReg.sh and JASConfig.params files to the server hosting Jazz Authorization Server

On the Jazz Authorization Server

• Copy the addNodeReg.sh and JASConfig.params files to [JAS_HOME] directory
• Edit JASConfig.params file and modify the JASPATH to set it to JAS install directory and JASCREDENTIALS to add an Admin user and password

  JASPATH=/opt/IBM/JazzAuthServer
  JASCREDENTIALS=elmadmin:elmadminpassword

• Find the ClientId of LQE Application
  • Access JAS URL https://JazzAuthServerURI/oidc/endpoint/jazzop/clientManagement and login as an Admin User
  • Search for Client name /lqe and copy the respective Client ID

• Run the following command to add original (behind Reverse Proxy) and new LQE Node URL (Update the clientId and URL)

   # ./addNodeReg.sh <ClientId> https://LQEPrimaryNodeURL:PORT/lqe
   # ./addNodeReg.sh <ClientId> https://LQENEWNodeURL:PORT/lqe

Test Individual LQE Nodes and change Node Names

Test by accessing individual LQE Node URLs

Primary LQE Node:

• Access the URL https://LQEPrimaryNodeURL:PORT/lqe/web/admin/nodes
• Click on the Node Name, Change name to example LQE_Primary_Node_1 and click Save

New LQE Node:

• Access the URL https://LQENEWNodeURL:PORT/lqe/web/admin/nodes
• Click on the Node Name, Change name to example LQE_New_Node_2 and click Save

Setup Apache HTTP Server or HAProxy as Load Balancer for the LQE nodes

We have documented instructions to setup Load Balancing for LQE using Apache HTTP Server

Reconfigure LQE redirection in Reverse Proxy to point to the Load Balancer

Test Load Balanced LQE

Related topics: Deployment web home, Deployment web home

External links:

• IBM

Additional contributors: TWikiUser, TWikiUser