You can submit the Generate merged plugin configuration
for Liberty profile servers job to create a single, merged plugin-cfg.xml file
that instructs a web server plug-in to redirect requests to multiple
application servers residing on multiple hosts. The job first generates
server-specific plugin-cfg.xml files on each
target host. The job then merges the server-specific plugin-cfg.xml files
into one plugin-cfg.xml file on the job manager
host.
Before you begin
Start the job manager and the Liberty profile servers on the
target hosts.
If you need to generate a web server
plug-in configuration for a single instance of a Liberty profile server, see "Configuring
the Liberty profile with a web server plug-in."
Your ID at
the job manager must be authorized for the administrator role or the
operator role to submit jobs.
When registering a target host
with the job manager, you can save operating system security information.
When you submit a job to one or more targets for which security information
has not been saved, you must specify an authorized operating system
user name and either password or public-private key information for
the user name. The security credentials must be valid for all job
targets.
This job requires a Java Management
Extensions (JMX) connection to
Liberty profile servers on the
target hosts. To configure a
Liberty profile server to support
JMX connections, add either the local connector feature or the HTTP/REST
connector feature to its
server.xml file. The
following example shows local connector feature and the HTTP/REST
connector feature within the feature manager element of a
server.xml file:
<featureManager>
<feature>localConnector-1.0</feature>
<feature>restConnector-1.0</feature>
...
</featureManager>
When submitting a job, if one or more
Liberty profile servers include
only the HTTP/REST connector feature, you must specify the user name
and password of a
Liberty profile server
administrator. The job manager uses these credentials when establishing
a JMX connection to the servers. If all the servers include the local
connector feature, you do not need to specify a user name and password.
For more information about defining server administrators,
see "Mapping the administrator role for the Liberty profile."
A
Liberty profile server requires a Java development kit (JDK) or Java
runtime environment (JRE) to run this job. Set the JDK or JRE location
by completing one of the following actions:
- Set the JAVA_HOME property to the JDK or JRE location in the server.env file.
The job reads the JAVA_HOME property and sets it
on the target environment before running the command to generate a plugin-cfg.xml file
for the Liberty profile server.
About this task
You can use the administrative console of the job manager
or the deployment manager to generate a single, merged plugin-cfg.xml file
that instructs a web server plug-in to redirect requests to multiple Liberty profile servers residing
on multiple hosts. From the console, choose the Generate
merged plugin configuration for Liberty profile servers job,
specify the servers and job options, review the summary, and submit
the job.
The steps describe how to run the Generate
merged plugin configuration for Liberty profile servers job
using the job manager console or the deployment manager console. Instead
of using a console, you can run the generateMergedPluginConfigForLibertyProfileServers
job script in the AdministrativeJobs command group. See the Administrative
job types topic.
Procedure
- Click from the navigation tree of the administrative console.
- Choose a job to generate a merged web server plug-in configuration
file for multiple Liberty profile servers.
- Select the Generate merged plugin configuration
for Liberty profile servers job type from the list.
- Optionally specify a description of the job.
- Click Next.
- Choose the job targets.
- Select a group of targets from the list, or select Target
names.
Only groups of targets that are valid
for the job type that you selected are displayed in the list of target
groups.
- If you selected Target names,
then specify a target name and click Add, or
click Find and specify the chosen targets on
the Find targets page.
- If you did not choose to save security
authentication information when registering the target hosts with
the job manager, specify an operating system user name and password
or public-private key information for access to the target hosts.
The security credentials must be valid for all the job targets.
- Click Next.
- Specify parameters for the Generate merged plugin
configuration for Liberty profile servers job.
- For Server(s), specify the resource
name or the fully-qualified resource ID of a server, or a pattern
that identifies one or more servers.
If a server name
resolves to more than one server of the same name, the product returns
an error and does not generate the plugin-cfg.xml file.
For example, suppose you want to specify defaultServer for
the server. You might specify one of the following values to identify
the server resource:
- Resource name
- defaultServer
- Fully-qualified resource ID
- runtime/wlp/liberty_server/defaultServer
- Resource name pattern
- *Server
- Fully-qualified resource ID pattern
- runtime/wlp/liberty_server/*
To see the names of existing Liberty profile servers on the
targets, click Find on the Specify
job parameters page. On the Find target resources page,
click Find to find a Liberty profile server identifier
that exists on all the targeted hosts. Select the server resource
ID for which to generate a merged web server plug-in configuration.
- If one or more of the servers include
only the HTTP/REST connector (restConnector) feature, for User
name, specify the user name of a Liberty profile server administrator.
The job manager uses this value when establishing a JMX connection
to the servers.
- If one or more of the servers include
only the HTTP/REST connector (restConnector) feature, for Password,
specify the password of the Liberty profile server administrator.
The job manager uses this value when establishing a JMX connection
to the servers.
- Click Next.
- Schedule the job.
The times and dates that
you specify are relative to the job manager.
- Optionally specify one or more email addresses where
notifications are sent when the job finishes.
If you
specify multiple email addresses, separate them with commas.
- Select when the job is available for submission.
- Select the job expiration.
- Optionally specify a recurring interval for the job,
a start date and time for the interval, and an end date and time for
the interval.
- Click Next.
- Review the summary, and click Finish to
submit the job.
Results
Server-specific plugin-cfg.xml files
are generated on each target host. The job manager then merges the
files into a single, merged plugin-cfg.xml file
on the job manager host.
What to do next
On the Job status page, click the
ID of the Generate merged plugin configuration for Liberty
profile servers job and view the job status. Click the
status refresh icon
to
refresh the displayed status.
If the job is successful, the
product writes the merged plugin-cfg.xml file
to the app_server_root/profiles/job_manager_profile/config/temp/JobManager/job_ID/_mergedPluginDir/ directory.
If
the job is not successful, the job stops and the product returns an
error when any of the following conditions exist:
- A targeted Liberty profile server is not running.
- No JMX connector is configured for a targeted Liberty profile server.
- The job properties do not specify valid server administrator credentials
for establishing a JMX connection to a targeted Liberty profile server that includes
only the HTTP/REST (restConnector) feature.
View any error messages that result from running the job, correct
the error condition, and submit the job again.