(r16) CLMDistributedSetupUsingLibertyProfile < Deployment

Engineering Lifecycle Management Wiki - Deployment
Community information and contribution guidelines
~~EditAttach~~Printable
TWiki > Deployment Web > DeploymentInstallingUpgradingAndMigrating > CLMDistributedSetupUsingLibertyProfile
Revision 16 - 2024-01-02 - 05:51:32 - ShradhaSrivastav
<div id="header-title" style="padding: 10px 15px; border-width:1px; border-style:solid; border-color:#FFD28C; background-image: url(<nop>https://jazz.net/wiki/pub/Deployment/WebPreferences/TLASE.jpg); background-size: cover; font-size:120%">
---+!! <img src="https://jazz.net/wiki/pub/Deployment/WebPreferences/new.png" alt="new.png" width="50" height="50" align="right"> Distributed Deployment of ELM on Liberty Profile using IBM HTTP Server
%DKGRAY% Authors: Main.ShubjitNaik, Main.DineshKumar <br>
Build basis: Engineering Lifecycle Management 7.0.x, !Websphere Liberty, IBM HTTP Server 9.0.x
%ENDCOLOR%</div></sticky>

<!-- Page contents top of page on right hand side in box -->
<sticky><div style="float:right; border-width:1px; border-style:solid; border-color:#DFDFDF; background-color:#F6F6F6; margin:0 0 15px 15px; padding: 0 15px 0 15px;">
%TOC{title="Page contents"}%
</div></sticky>
%BR%
<sticky><div style="margin:15px;"></sticky>
A common installation topology is a distributed deployment of a IBM Engineering Lifecycle Management (ELM), [[https://jazz.net/wiki/bin/view/Deployment/StandardTopologiesOverview#Enterprise_topologies][Enterprise topology]], which means each ELM application can be deployed and configured separate Liberty Profiles.

%BR%We bundle !WebSphere Liberty as the default application server with ELM and this article will focus on configuring a distributed deployment of ELM using !WebSphere Liberty. Here are a couple of scenarios where we would need a distributed setup.

   * _Deploy a distributed setup using !WebSphere Liberty where each ELM application is setup on its own Liberty Profile_
   * _Deploy one or a set of applications (example Reporting components LQE, DCC and JRS) on a separate Liberty Profile (This specific scenario will be used in this article)_
   * _Adding additional application instances such as EWM1 / ETM1 / ERM1 with the bundled Liberty Profile connecting to JTS/EWM/ETM residing on a separate Liberty Profile_

The steps in this article is to be used as a guideline to help setup and configure a distributed deployment of ELM on Liberty Profile. We have included additional links within this article that will help in configuring LDAP, SSO for Liberty and additional IHS configurations.

---++ Prerequisites and Assumptions

   * Liberty Profile bundled with the installation is used (ie. not the Liberty Profile downloaded separately)
   * Each of the Liberty profile is configured to use the same LDAP server with domain "example.org" for authentication (We will not consider the basic user registry in this example)
   * A separate database server is available and setup for ELM, instructions available on our [[https://www.ibm.com/docs/en/elm/7.0.2?topic=management-setting-up-database][Infocenter]]
   * IBM HTTP Server installation is available or download a [[https://www.ibm.com/support/pages/installing-no-charge-unsupported-ibm-http-server][No Charge archive install version of IHS]]
   * License configuration would not be covered in this article

---++ Example server configuration

For the purposes of this article we will use three separate servers configured as follows:

   * Server 1 (Hostname: *ihs.example.org*): IBM HTTP Server (IHS) listening on port 80 / 443 , GC/LDX installed with bundled Liberty Profile_
   * Server 2 (Hostname: *elm.example.org*):  JTS/EWM/ETM/ERM installed with the bundled Liberty Profile (Default HTTPS port : 9443)
   * Server 3 (Host-name: *reporting.example.org*): JRS/DCC/LQE installed with bundled default Liberty Profile (Default HTTPS port : 9443)

---++ Overview of the Setup

   * Install ELM applications on Server 1, 2 and 3
   * Install and configure IHS Server on Server 1
   * Configure Web Server Plugins 
   * Merge Plugins from each Liberty Profile for IHS
   * Configure user registry on each Liberty Profile
   * Configure SSO across the Liberty Profiles

---++ The Setup

---+++ Application Installation
Install ELM applications on different machines using IBM Installation Manager

   * Download and Install [[https://jazz.net/downloads/ibm-installation-manager/][IBM Installation Manager (IM)]] on each Server
   * Download ELM application installer from Passport Advantage or from jazz.net
   * Install JTS/EWM/ERM/RM applications on Server 2 using WAS Liberty
      * Edit =[JAZZ_HOME]\server\liberty\servers\clm\conf\application.xml= and comment out the application lines for those that were not installed on Server 2
   * Install GC/LDX applications on Server 1 
      * Edit =[JAZZ_HOME]\server\liberty\servers\clm\conf\application.xml= and comment out the application lines for those that were not installed on Server 1
   * Install Reporting components, JRS, DCC and LQE on Server 3
      * Edit =[JAZZ_HOME]\server\liberty\servers\clm\conf\application.xml= and comment out the application lines for those that were not installed on Server 3

---+++ Install IBM HTTP Server

If your organization has a copy of the !WebSphere Application Server Supplements repository downloaded via passport advantage, you can use that repo and install IBM HTTP Server and !WebSphere Plugins using IBM IM on Server1

If you don't have access to the repo, you can download and install an IBM HTTP Server using the instructions on this [[http://www-01.ibm.com/support/docview.wss?uid=swg21972167][Technote]]%BR%
=Trial versions of IBM HTTP Server are not eligible for customer or product support. For best-effort/community support, see the ibmhttpserver tag on [[http://stackoverflow.com][stack overflow]]=

OR 

   * Download IHS from following link https://www.ibm.com/support/pages/node/617655
   * One you select the Version, scroll down to Archive Packages (example 9.0.5.18) https://www.ibm.com/support/pages/node/7087536#IHSArchive
   * Download Jave 8 - Archive https://www.ibm.com/support/pages/ibm-sdk-java-technology-edition-version-80-websphere-liberty-using-archives
   * set =JAVA_HOME to jre folder= %BR%
   * run =postinstall= from IHS home


*Steps to Install IHS (Trial version)* %BR%
   * Download and Install [[https://jazz.net/downloads/ibm-installation-manager/][IBM Installation Manager (IM)]]
   * Open IM and Click File > Preferences > Add Repository
   * Example, for 8.5.5.x, add the URL http://www.ibm.com/software/repositorymanager/com.ibm.websphere.IHSILAN.v85/repository.xml and click Ok
   * Click Install and complete the installation (example location C:\IBM\HTTPServer)
Post install, we have to create a new key database and a self signed certificate, enable SSL directives within the IBM HTTP Server's configuration file (httpd.conf), enable support modules and create a key database for certificates. We then complete the configuration using one of the methods for traffic redirection to the Liberty profiles.

---+++ Create a key database and configure IHS
 
The instructions are documented in the following Deployment Wiki article:
   * [[https://jazz.net/wiki/bin/view/Deployment/CreateIHSPLUGINFORLIBERTYPROFILE#Create_a_Keystore_and_Certificat][Create IHS Plugin for Liberty Profile]]
   * [[https://jazz.net/wiki/bin/view/Deployment/CreateIHSPLUGINFORLIBERTYPROFILE#Modify_the_httpd_conf_File][Modify httpd configuration file]]

---+++ Configure Web Server Plug-ins directive on IHS
This configuration is to route requests for dynamic content, such as servlets, from web applications. We will look into the web server plugin method to configure reverse proxy.
---++++ Configure IHS with Web Server Plugins (Recommended)
The Web server plug-in works with a web server to route requests for dynamic content, such as servlets, from web applications. The web servers (IHS), are necessary for directing traffic from browsers to the applications that run on an application server (Liberty profile). The web server plug-in uses the XML configuration file to determine whether a request is for an application server.
 %BR%

The steps to configure includes generating plug-ins from each Liberty server hosting CLM applications, Merge the plugins into one and include the path to the merged plugin file in IHS.
For detailed instructions on generating plugins from Liberty Profile and configuring IHS with it, visit the article [[CreateIHSPLUGINFORLIBERTYPROFILE][Creating IHS Plugin for Liberty Profile]]%BR%

From version 6.0.5 the plugin-cfg.xml file for each application server instance is auto generated during startup. It would be created in the following location:
=[JAZZ_HOME]\server\liberty\servers\clm\logs\state=

Follow the steps to copy plugin file and ELM certificate to IHS Server

   1. Copy the certificate from =[JAZZ_HOME]\server\liberty\servers\clm\resources\security= (All Application Servers) to =[WebSphere_PluginInstall]\Plugins\config\WebServer1= (IHS plugin folder) and rename it. 
      * For example, copy ibm-team-ssl.p12 from JTS and rename it to jts_ibm-team-ssl.p12 on IHS server. Use the updated name when performing changes to Plugin Config file mentioned in step3.
   1. Copy the plugin file from =[JAZZ_HOME]\server\liberty\servers\logs\state\plugin-cfg.xml= to =[WebSphere_PluginInstall]\Plugins\config\WebServer1\plugin-cfg.xml=
       You need to run clm once to generate the plugin 
   1. Open the plugin-cfg.xml file and update the changes as described in [[https://jazz.net/wiki/bin/view/Deployment/CreateIHSPLUGINFORLIBERTYPROFILE#Changes_to_the_Plugin_Config_Fil][Changes to the Plugin Config File]]

*Stash the JTS(Application) keystore password* %BR%

As with ELM 703 ikeyman is no longer shipped you can use the following command to stash the password of default or new keystore created from ELM applications and use the same values while updating the plugin files. 

=./gskcmd -keydb -stashpw -db ../ibm-team-ssl.p12 -pw ibm-team=

   * [[https://jazz.net/wiki/bin/view/Deployment/ConfigureCACertificateIn703][Configure Certificates in ELM 703]] 

---+++++ Merging Plugins

To merge the plugins from all application server profile instances, you can use the !PluginUtility command which is available on the Liberty version bundled with CLM version 6.0.4 onwards.
Steps to Merge the Plugins:
   * Copy all the Plugins into one folder, example =c:/plugins=
   * Navigate to =<JAZZ_HOME>\server\liberty\wlp\bin=
   * $ =pluginUtility merge --sourcePath=C:/plugins --targetPath=C:/targetDir/myMergedPluginCfg.xml=

You would need to edit the !MergedPluginCfg.xml file and change the path to logs, certificate kdb locations and also edit the httpd.conf file to read the newly merged plugin file. Follow the steps from the article [[CreateIHSPLUGINFORLIBERTYPROFILE][Creating IHS Plugin for Liberty Profile]]

---+++ Configuring Liberty Profiles with LDAP

Each instance of !WebSphere Liberty Profile should be configured with the same user registry (ideally LDAP). The user registry settings must be identical on all servers for SSO to work. You can complete running JTS Setup during this process.

[[ConfigureLDAPforLibertyProfile][Instructions to configure the Liberty Profile with LDAP]]

---+++ Configuring SSO Across the Liberty Profiles
It is critical to configure Single Sign-On between these application servers such that a user only needs to log into one of the application and subsequent access to the other applications will not require re-authentication.

[[ConfigureSSOforLibertyProfile][Instructions to configure Single Sign On (SSO) across the Liberty Profiles]]

---++ General Guidelines for distributed setup of CLM on Liberty Profile
   * To be able to configure reverse proxy using Web server plug-ins, an installation of !WebSphere Application server is mandatory, as the !MergePlugin.bat/sh file is not available out of this installation.
   * To be able to use a no-charge IBM HTTP Server with CLM without a need to obtain the Full installation media for !WebSphere application server, you would have to configure the Reverse proxy using the mod_proxy method
   * A !ProxyPass and !ProxyPassreverse directive combination is required for each application to route traffic from IHS to specific CLM application
%BR%

---+++++!! Related topics: [[ConfigureLDAPforLibertyProfile][Configure Liberty with LDAP]], [[ConfigureSSOforLibertyProfile][Configure SSO For Liberty]], [[CreateIHSPLUGINFORLIBERTYPROFILE][Generating Web server Plug-ins on Liberty Profile]], [[DeploymentWebHome][Deployment web home]]

---+++++!! External links:          

   * [[https://www.ibm.com][IBM]]

<sticky></div></sticky>
Copyright © by IBM and non-IBM contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.