Generate a merged plug-in configuration for Liberty servers using the job manager
We 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.
Start the job manager and the Liberty servers on the target hosts.
If we need to generate a web server plug-in configuration for a single instance of a Liberty server, see Liberty documentation about configuring Liberty 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, we can save operating system security information. When submitting a job to one or more targets for which security information has not been saved, 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 servers on the target hosts. To configure a Liberty 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 servers include only the HTTP/REST connector feature, specify the user name and password of a Liberty 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, we do not need to specify a user name and password.
For more information about defining server administrators, see "Mapping the administrator role for Liberty."
A Liberty 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 server.
- (AIX) (HPUX) (Linux) (Solaris) (ZOS) Set the JAVA_HOME property to the JDK or JRE location in the user .bashrc file.
- (AIX) (HPUX) (Linux) (Solaris) (ZOS) Append the JDK or JRE path to the PATH environment variable.
- (Windows) Set the JAVA_HOME property to the JDK or JRE location as a system environment variable.
- (Windows) Append the JDK or JRE path to the PATH system variable.
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 servers residing on multiple hosts. From the console, choose the Generate merged plugin configuration for Liberty 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, we can run the generateMergedPluginConfigForLibertyProfileServers job script in the AdministrativeJobs command group. See the Administrative job types topic.
- From the navigation tree of the administrative console, click...
Jobs > Submit
- Choose a job to generate a merged web server plug-in configuration file for multiple Liberty 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 we selected are displayed in the list of target groups.
- If we 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 we 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 plugin-cfg.xml.
For example, suppose we want to specify defaultServer for the server. We might specify one of the following values to identify the server resource:
- Resource name
- Fully-qualified resource ID
- Resource name pattern
- Fully-qualified resource ID pattern
To see the names of existing Liberty servers on the targets, click Find on the Specify job parameters page. On the Find target resources page, click Find to find a Liberty 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 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 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 specified are relative to the job manager.
- Optionally specify one or more email addresses where notifications are sent when the job finishes.
If we 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.
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 server is not running.
- No JMX connector is configured for a targeted Liberty server.
- The job properties do not specify valid server administrator credentials for establishing a JMX connection to a targeted Liberty 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.
Start and stop the job manager Install Liberty resources using the job manager Checking job status Administrative job types Find targets Find target resources Target resources collection