Generating the plug-in configuration in a high availability environment

You can configure the Web server plug-in configuration to generate in a high availability environment to ensure that the configuration is always generated by one process in the cell regardless of other processes that might not be available.

Before you begin

Establish your high availability environment. See Setting up a high availability environment for more information.

Configure core groups that are in the same cell need to share workload management (WLM) information. See Configuring communication between core groups that are in the same cell for more information.

Using the high availability plugin-cfg generation service does not automatically disable the on demand router (ODR) plugin-cfg generation if it is enabled. The two services are independent. It is redundant to enable both services, so any ODR plugin-cfg generation that was configured should be disabled when enabling the high availability plugin-cfg generation service. See Configuring an on demand router to dynamically update the Web server plug-in configuration for more information.

About this task

Define a set of custom properties at the cell level for each plugin-cfg.xml file that you want to generate. The custom properties are formatted as ODCPluginCfg<property>_<config>=value, where <property> is one of the following elements:
  • OdrList
  • OutputPath
  • UpdateScript
  • OdrClusterList
  • Disabled
The <config> variable is the name of the configuration that you choose. As a result, the properties end in the same <config> variable to define a single configuration for the generation of the high availability plugin-cfg.xml file.

Procedure

  1. In the administrative console, click System administration > Cell > Custom Properties > New.
  2. Define the following custom properties:
    ODCPluginCfgOdrList_<configName>=cell1:node1:odr1,cell2:node2:*
    This property specifies the ODRs that you want to include in the plugin-cfg.xml file. Use the * symbol as a valid wildcard for each path segment.
    ODCPluginCfgOutputPath_<configName>=/path/file_name.txt
    This property specifies the location in which the plugin-cfg.xml file is placed after the file is generated. Because you can generate the plug-in configuration on any node in the cell, you must ensure the output directory exists on each node.
    ODCPluginCfgUpdateScript_<configName>=/path/script <parameter1> <parameter2>
    This property runs a script to update the configuration each time the plugin-cfg.xml file changes. Because you can generate the plug-in configuration on any node in the cell, the script must exist in this path on all nodes.
    ODCPluginCfgOdrClusterList_<configName>=cell1:cluster1
    This property specifies a cluster of ODRs that you want to include in the plugin-cfg.xml file.
    ODCPluginCfgDisable_<configName>=true
    This optional property disables the generation of a particular configuration without undefining all of the properties for that configuration. The default value is false.
    ODCPluginCfgOdrSessionIdCookie _XYZ
    This property defines the name of the cookie used to maintain IBM HTTP server/ODR affinity when using ODR cell affinity.
    ODCPluginCfgIHSConfigProperties_XYZ
    This property is used instead of configuring JVM properties (as is done during non-HA plugin-cfg generation) to set IBM HTTP server specific configuration properties. The format is PROPERTY_NAME1=value1,PROPERTY_NAME2=value2
    ODCPluginCfgTrustedProxyList_<configName>=trustedproxy1,trustedproxy2
    This property is used to specify the trusted proxies that you want to include in the plugin-cfg.xml file.
    See Controlling the generation of the plugin-cfg.xml file for the list of valid property names and values.
Set the following cell custom properties to generate the plug-in configuration for a collection of ODRs that are not in an ODR cluster. Note that all properties end with _1, which ties them together into a single configuration.
Table 1. Custom properties used to generate a plug-in configuration for ODRs that are not in a cluster
Property name Property value Description

ODCPluginCfgOdrList_1

myCell:*:*

Generates a plug-in configuration that will route to all the ODRs in the myCell cell.

ODCPluginCfgOutputPath_1

/tmp/plugin-cfg1.xml

Writes the generated plug-in configuration to the /tmp/plugin-cfg1.xml file.

ODCPluginCfgUpdateScript_1

/root/bin/pluginCfgUpdate1

The path to the script that is ran each time the /tmp/plugin-cfg1.xml file is updated.

Set the following cell custom properties to generate the plug-in configuration for a cluster of ODRs named myCell/myOdrCluster. Note that all properties end with _2, which ties them together into a single configuration.
Table 2. Custom properties used to generate the plug-in configuration for myCell/myOdrCluster
Property name Property value Description

ODCPluginCfgOdrClusterList_2

myCell:myOdrCluster

Generates a plug-in configuration that will route to all the ODRs of the myOdrCluster cluster in the myCell cell.

ODCPluginCfgOutputPath_2

/tmp/plugin-cfg2.xml

Writes the generated plug-in configuration to the /tmp/plugin-cfg2.xml file.

ODCPluginCfgUpdateScript_2

/root/bin/pluginCfgUpdate2

The path to the script that is ran each time the /tmp/plugin-cfg2.xml file is updated.

ODCPluginCfgODRIncludeStopped_2

true

or

false

Includes or excludes stopped ODRs.

What to do next

Because the generation of the plugin-cfg.xml file can occur on any node in the cell, you can determine the specific location in which the generation service is running in one of two ways:
  • In the administrative console, click Runtime Operations > Extended Deployment > Core components. Verify that HAPluginCfgGenerator is displayed in the table.
  • Run the following script:

    wsadmin.sh -f checkODCPluginGenLocation.jacl


The URL for this topic is: