GlassFish - World's first Java EE 7 Application Server


Load Balancer Documentation Plan for GlassFish Server Open Source Edition 3.1

People and Roles

Name Role Location Time Zone Email
Scott Fordin Documentation Feature Owner Burlington, MA, USA US/Eastern sfordin@dev.java.net
Kshitiz Saxena Project Lead Bangalore, India IST kshitiz_saxena@dev.java.net
Mahesh Kannan Software Engineer Santa Clara, CA, US US/Pacific maheshkannan@dev.java.net
Joe Di Pol Software Engineer Santa Clara, CA, US US/Pacific jfdipol@dev.java.net
Yamini K B Software Engineer Bangalore, India IST yaminikb@dev.java.net
Homer Yau Quality Engineer Santa Clara, CA, US US/Pacific hyau@dev.java.net
Paul Davies Peer Reviewer Santa Clara, CA, USA US/Pacific pauldavies@dev.java.net

Audience

This feature is aimed at system administrators and application developers.

Summary of the Feature From a User's Perspective

With the introduction of clustering support in GlassFish 3.1, there is a basic requirement for a Load Balancer component to distribute incoming requests to cluster instances. This Load Balancer must provide controls for managing such features as detecting cluster health and request route renegotiation, among others, thereby providing high availability and performance.

The Load Balancer Plugin for GlassFish is a native plugin that is installed on a Web server. After installing and configuring the Load Balancer Plugin, the Web server will start distributing requests across GlassFish cluster instances and provide a number of features, including failover handling.

A LoadBalancer Configurator installer will automate most of the required and error-prone Load Balancer configuration procedures.

Availability

This feature is available in the GlassFish Server Full distribution.

Statement of Work

This section describes in detail for each document the work that is required by the introduction of the feature, such as changes, addition of new material, relocation of existing material, and removal of existing material.

Documentation Impact:

  • None
  • Minor
  • Moderate
  • Major
  • New

Note - If a document is task based (as opposed to reference), the changes should be determined from the user task analysis for the feature.

Changes to Books

Administration Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
6, Administering Web Applications, Administering mod_jk Minor Scott Kshitiz Remove paragraph that states specific version compatibility.

Quick Start Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Working With Load Balancers Moderate Scott Kshitiz, Yamini Adapt chapter from 2.1.1 QSG

High Availability Administration Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
1, High Availability in Enterprise Server Moderate Scott Kshitiz, Yamini Adapt chapter from 2.1.1 HAAG
High Availability and Failover; several sections Moderate Scott Kshitiz, Yamini Update HADB support information; HADB not supported in this release.
5, Configuring HTTP Load Balancing, various sections New Scott Kshitiz, Yamini Adapt chapter from 2.1.1 HAAG
Throughout Moderate-Major Scott All reviewers Clean up HADB references throughout book; there are quite a lot of them

Changes to man Pages

asadmin man Page Changes

Topic Title Documentation Impact Writer Reviewers Description of Change
apply-http-lb-changes
configure-lb-weight
create-http-health-checker
create-http-lb-config
create-http-lb-ref
create-http-lb
delete-http-health-checker
delete-http-lb-config
delete-http-lb-ref
delete-http-lb
disable-http-lb-application
disable-http-lb-server
enable-http-lb-application
enable-http-lb-server
export-http-lb-config (add --target parameter)
list-http-lb-configs
list-http-lbs 		Moderate Scott Kshitiz, Yamini Adapt Load Balancer subcommands from 2.1.1 man pages, update defaults, state that these subcommands are not applicable to GF Open Source Edition.
create-instance
deploy 		Minor Scott Joe, Homer Add new lb-enabled attribute, state that attribute is not applicable to GF Open Source Edition.

Review Schedule

The review schedule for the documentation items that are affected by this feature is provided in the following table.

Item Review Start Date Review End Date
Administration Guide    
asadmin man Page    
Domain File Format Reference    
High Availability Administration Guide    
Quick Start Guide    

Reviewers are listed in the Statement of Work.

Related Information

Email aliases:

Comments:
Comment ID
Section Comment
PMD-001
 People and Roles
 Joe and Mahesh are both based in Santa Clara, CA, USA.
PMD-002 Quick Start Guide Changes Wherever HADB is mentioned, change the description to state that the information will be deleted. HADB is not supported in this release.
PMD-003 High Availability Administration Guide Changes, 10, Java Message Service Load Balancing and Failover Delete this row as JMS load balancing and failover are handled in a separate project.
PMD-004 High Availability Administration Guide Changes:
  • 11, RMI-IIOP Load Balancing and Failover
  • Overview, Algorithm
 Delete these rows as IIOP load balancing and failover are handled in a separate project.
PMD-005 Domain File Format Reference Changes Add a row for the Element Hierarchy section and state which elements you'll be adding.
PMD-006 Domain File Format Reference Changes, 1, The domain.xml File, Alphabetical List of Elements I believe that a v2.1.1 description of all the elements pages that you listed as new exists, so you can probably change the documentation impact to moderate.
PMD-007 Upgrade Guide Changes, Upgrading Node Agents Delete this row as node agents are not supported in this release. I will find out from the SSH provisioning team if any corresponding procedures for nodes are required.
PMD-008 Reference Manual Changes Delete this section. The changes to man pages are propagated automatically to the Reference Manual without further intervention from the writer, so they do not need to be listed twice.
PMD-009 Changes to Man Pages
I believe that a v2.1.1 version of all the man pages that you listed as new exists, so you can probably change the documentation impact to moderate.
Posted by pauldavies at Jul 28, 2010 17:49
Comment ID Comment
PMD-001 Corrected addresses, also added Yamini as a reviewer.
PMD-002 Removed all but one of the HADB table rows; remaining row states HADB not supported in 3.1
PMD-003 Deleted row.
PMD-004 Deleted rows.
PMD-005 Clarified changes, added new row.
PMD-006 Changed doc impact to Moderate.
PMD-007 Deleted row.
PMD-008 Deleted section.
PMD-009 Changed doc impact to Moderate.
SRF-001 Incorporated a bunch of comments from Kshitiz.
Posted by sfordin at Aug 06, 2010 18:14
Comment ID Section Comment
SRF-002 Administration Guide Changes Added new section; changes related to mod_jk.
SRF-003 Upgrade Guide Changes Removed entire section because it referred mostly to LB Plugin and Configurator.
SRF-004 Online Help Changes Removed entire section because there will be no changes to online help.
SRF-005 Several locations Removed references to LB Plugin and Configurator.
SRF-006 Several locations Changed names of reviewers.
SRF-007 Domain File Format Reference Changes Removed duplicate table row.
Posted by sfordin at Aug 11, 2010 13:00
Comment ID Section Comment
SRF-008 man pages and Domain File Format Reference State that LB subcommands and attributes are not applicable to GF OSE.
Posted by sfordin at Aug 18, 2010 13:41