Configure simple load balancing across multiple application server profiles with an administrative agent

Simple load balancing distributes HTTP requests across multiple IBM WebSphere Application Server instances. Also, we can configure simple load balancing to provide failover of an application state that is maintained in an HTTP session.

Supported configurations: This offering applies to stand-alone application server profiles for IBM WebSphere Application Server. This offering does not include a centralized management capability such as the deployment manager in WebSphere Application Server Network Deployment.

We can configure simple load balancing capability with WebSphere Application Server by combining the plug-in configuration files of multiple stand-alone application server profiles into a single configuration file. The number of configuration files that we can combine are bound by the limits that exist in the WAS license agreement. We can use the following different configurations of the application server to combine the plug-in configuration files of multiple application server profiles into a single output file:

• Use multiple stand-alone base application server profiles. For more information, see the documentation on configuring simple load balancing across multiple application server profiles.

• Use multiple stand-alone base application server profiles with an administrative agent. This topic explains how to complete this configuration.

• Use multiple stand-alone base application server profiles with an administrative agent using the job manager. The job manager function is a part of WAS Network Deployment. However, we can use the job manager function with stand-alone, base application server profiles. For more information, see the documentation on configuring simple load balancing across multiple stand-alone, base application server profiles with an administrative agent using the job manager.

Complete the following steps to register stand-alone application server profiles with an administrative agent and combine the plug-in configuration files from these profiles into a single output file.

1. Install WebSphere Application Server and create application server profiles. For more information, see the documentation on WebSphere Application Server installation and application server profiles.

2. Configure the administrative agent and register each application server profile with the administrative agent. Complete the following steps:

   1. Set up the administrative agent, which includes creating the administrative agent profile.

   2. Register the stand-alone application server with the administrative agent.

   3. Start and stop the administrative agent.

   After completing these steps, we can complete all the administrative operations through the administrative agent. When you log in to the administrative console for the administrative agent, we can select which application servers to manage. For more information, see the documentation on administering stand-alone nodes using the administrative agent.

3. Install the enterprise application or web module. For more information, see the documentation on installing enterprise applications or modules.

4. Determine if you require session affinity.

   Session affinity directs requests from a given client to a specific application server. The application state maintained in the HTTP session is accessed in the HTTP session cache, which is local to the application server. Session affinity provides higher performance than database persistence of the session object, alone. Without session affinity, session requests must be obtained from the database if they are sent to a server that does not have the session object in the local cache.

5. Optional: Configure a unique HTTP session clone ID for each application server. Complete this step if you require session affinity.

   We can configure a unique HTTP session clone ID using wsadmin scripting or the administrative console. To use wsadmin commands for the Jython or Jacl programming language, see the documentation on configuring a unique HTTP session clone ID for each application server . To configure a unique HTTP session clone ID using the administrative console...

   1. Expand Servers > Server Types and click WebSphere application servers > server_name.

   2. Under Container Settings, expand Web Container Settings, and click Web container.

   3. Under Additional Properties, click Custom properties > New.

   4. In the Name field, enter HttpSessionCloneId.

   5. In the Value field, enter a unique value for the server. The unique value must be 8 - 9 alphanumeric characters; for example, test1234

   6. Click Apply or OK.

   7. Click Save to save the configuration changes to the master configuration.

6. Optional: Configure session persistence. If we require session failover capability, configure session persistence. Persistence of the session object to a database is the only option for session failover with WebSphere Application Server. To configure session persistence using the administrative console, see the documentation on configuring database session persistence. To configure database session persistence using wsadmin commands for the Jython or Jacl programming language, see the documentation on configuring database session persistence .

7. Restart the server.

8. Generate the plugin-cfg.xml file for each stand-alone application server using the GenPluginCfg script, the administrative console, or wsadmin scripting.

   To use the GenPluginCfg script, enter the following command on the command line: profile_root/config/cells/GenPluginCfg.sh|bat

   To use the administrative console, see the documentation on creating or updating a global web server plug-in configuration file.

   The following variables apply to the Jython and Jacl commands:

   • cell_name is the name of the cell.

   • web_server_node is the name of the node for the web server.

   • web_server_name is the name of the web server.

   Jython

   On the command line, enter each of the following commands on a separate line:

   generator = AdminControl.completeObjectName('type=PluginCfgGenerator,*')
   AdminControl.invoke(generator, 'generate', " profile_root/config cell_name web_server_node web_server_name true true")

   Jacl

   On the command line, enter each of the following commands on a separate line:

   set generator [$AdminControl completeObjectName type=PluginCfgGenerator,*]
   $AdminControl invoke $generator generate " profile_root/config cell_name web_server_node web_server_name true true"

9. Merge the plugin-cfg.xml files from multiple application server nodes.

   We can either manually merge the plugin-cfg.xml files or use the pluginCfgMerge tool to automatically merge the plugin-cfg.xml file from multiple application server profiles into a single output file. The pluginCfgMerge.bat or pluginCfgMerge.sh tool is available after you install this fix pack and is located in the install_root/bin directory. To use the pluginCfgMerge tool...

   1. Rename the plugin-cfg.xml files to a unique name across the application server profiles.

   2. Copy the plugin-cfg.xml file for all stand-alone application server profiles into a common directory.

   3. Use the pluginCfgMerge tool to combine the plugin-cfg.xml files from each of the application server profiles into a single output file. For example:
      

      (iseries)

      (zos)

      install_root/bin/pluginCfgMerge.sh plugin_configuration_file1 plugin_configuration_file2 resulting_plugin_configuration_file

      
      

      install_root\bin\pluginCfgMerge.bat plugin_configuration_file1 plugin_configuration_file2 resulting_plugin_configuration_file

      The resulting_plugin_configuration_file variable value is normally plugin-cfg.xml

   For more information about manually merging the plugin-cfg.xml files, see the technote on merging plugin-cfg.xml files from multiple application server profiles.

10. Copy the merged plugin-cfg.xml file to the plugin_installation_root/config/web_server_name/ directory on the Web server host.

11. Ensure that we have defined the correct operating system file access permissions for the merged plugin-cfg.xml file. These file access permissions allow the HTTP server plug-in process to read the file.

Results

When you complete this process, we have one plug-in configuration file for multiple stand-alone application server profiles.

Related concepts

Ways to install enterprise applications or modules

Administrative agent

Related tasks

Create application server profiles

Configure for database session persistence

Create or update a global web server plug-in configuration file

Configure a unique HTTP session clone ID for each application server

Configure database session persistence

Administer stand-alone nodes using the administrative agent

Related information:

Merging plugin-cfg.xml files from multiple nodes