Clustering Infrastructure Documentation Plan for GlassFish Server Open Source Edition 3.1

People and Roles

Name Role Location Time Zone Email
Paul Davies Documentation Feature Owner Santa Clara, CA, USA US/Pacific pauldavies@dev.java.net
Rebecca Parks Peer Reviewer Santa Clara, CA, USA US/Pacific junesm@dev.java.net
Tom Mueller Software Engineer Omaha, NE, USA US/Central tmueller@dev.java.net
Bill Shannon Software Engineer Santa Clara, CA, USA US/Pacific shannon@dev.java.net
Jennifer Chou Software Engineer Painesville, OH USA US/Eastern jc129909@dev.java.net
Byron Nevins Software Engineer Santa Clara, CA, USA US/Pacific bnevins@dev.java.net
Bhakti Mehta Software Engineer Santa Clara, CA, USA US/Pacific bhaktimehta@dev.java.net
Anissa Lam Software Engineer Santa Clara, CA, USA US/Pacific anilam@dev.java.net
Cheng Fang Software Engineer Burlington, MA, USA
US/Eastern cf126330@dev.java.net
Vijay Ramachandran Software Engineer Santa Clara, CA, USA US/Pacific vijaysr@dev.java.net
Elena Asarina QA Engineer Santa Clara, CA, USA US/Pacific easarina@dev.java.net

Audience

This feature is aimed at system administrators.

Summary of the Feature From a User's Perspective

The Clustering Infrastructure feature enables basic functionality for the creation and management of clusters of multiple GlassFish Server instances.

This feature also provides the clustering infrastructure that is required to support other features such as session replication, load balancing, and failover.

Availability

This feature is available in the Web Profile distribution and the Full Platform 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
Chapter 3, Administering Domains Moderate Paul Tom Mueller
Bill Shannon
Reinstate conceptual information from v2.1.1 documentation about the DAS and server instances.
To Configure a Domain for Automatic Restart on Linux
New
Paul
Byron Nevins
Add this task.

High Availability Administration Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Chapter 1, High Availability in GlassFish Server Moderate Paul Tom Mueller
Bill Shannon
Reinstate this chapter from v2.1.1 documentation. Remove references to HADB.
Upgrading Applications Without Loss of Availability in Chapter 5 Configuring HTTP Load Balancing

Minor Paul Yamini KB
Vijay Ramachandran
Reinstate this section from v2.1.1 documentation.
Chapter 6, Setting Up Clusters in GlassFish Server Major Paul Tom Mueller
Bill Shannon
Hong Zhang
Reinstate the section Overview of Clusters.
Move tasks that use the GUI to the online help.
Explain how to use the asadmin utility to perform the following tasks:
  • Create a cluster
  • Stop, start, and delete clustered instances
  • Configure server instances in a cluster
  • Configure applications for a cluster
  • Configure resources for a cluster
  • Delete a cluster
  • Configure a cluster offline
  • Upgrade components without loss of service
Chapter 7, Managing Configurations Major Paul Tom Mueller
Bill Shannon
Reinstate this chapter from v2.1.
Move tasks that use the GUI to the online help.
Explain how to use the asadmin utility to perform the tasks that were moved to the online help.
Synchronizing GlassFish Server Nodes and the DAS in Chapter 8, Configuring GlassFish Server Nodes New Paul Tom Mueller
Bill Shannon
Describe in detail which files are updated when the DAS and GlassFish Server nodes are resynchonized, either when the server is started or in response to a request from the user.
Explain how to perform the following tasks:
  • Initiate a resynchronization
  • Resynchronize changes to files that a user has made
  • Prevent resynchronization of configuration files
  • Prevent deletion of user-created files
  • Manually resynchronize GlassFish Server nodes and the DAS
    Note - Some documentation about Node Agents in the v2.1.1. documentation might be useful input to this section.

Upgrade Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Deprecated and Unsupported Options Moderate Paul Davies Bhakti Mehta
Bill Shannon
Tom Mueller
State that the following HADB-related options of the create-cluster subcommand are obsolete and are ignored:
  • --hosts
  • --haagentport
  • --haadminpassword
  • --haadminpasswordfile
  • --devicesize
  • --haproperty
  • --autohadb
  • --portbase

Domain File Format Reference Changes

Section Documentation Impact Writer Reviewers Description of Change
Element Hierarchy Minor Paul Byron Nevins
Jennifer Chou
Reinstate clusters and all its subelements.
application-ref Minor Paul Byron Nevins
Jennifer Chou
Add cluster to the list of superelements.
cluster Minor Paul Byron Nevins
Jennifer Chou
Reinstate from the v2.1.1documentation.
clusters Minor Paul Byron Nevins
Jennifer Chou
Reinstate from the v2.1.1documentation.
configs Minor Paul Byron Nevins
Jennifer Chou
Change Required column to allow one or more config subelements.
health-checker Minor Paul Byron Nevins
Jennifer Chou
Reinstate from the v2.1.1documentation.
resource-ref Minor
Paul
Byron Nevins
Jennifer Chou
Add cluster to the list of superelements.
server-ref Minor Paul Byron Nevins
Jennifer Chou
Reinstate from the v2.1.1documentation.
servers Minor Paul Byron Nevins
Jennifer Chou
Change Required column to allow one or more server subelements.
system-property Minor Paul Byron Nevins
Jennifer Chou
Add cluster to the list of superelements.

Add-On Component Development Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Chapter 4. Extending the asadmin Utility Moderate Rebecca Tom Mueller
Bil Shannon
Jerome Dochez
Explain how to perform the following tasks:

Changes to Online Help

All changes to online help, including those arising from the Clustering Infrastructure feature, are detailed in Administration Console Documentation Plan.

Changes to Man Pages

Man Page Name and Section Documentation Impact Writer Reviewers Description of Change
add-resources(1) Minor Paul Jagadish Ramu Change sun-resources to glassfish-resources in references to the DTD.
create-cluster(1) Minor Paul Bhakti Mehta
Reinstate this man page from v2.1.1.
Add the --gmsenabled option to Synopsis and options.
State that the following HADB-related options are obsolete and are ignored:
  • --haagentport
  • --haadminpassword
  • --haadminpasswordfile
  • --devicesize
  • --haproperty
  • --autohadb
  • --portbase
create-domain(1) Minor Paul Tom Mueller
Add description of --template domain-template option.
create-instance(1) Minor Paul Carla Mott
Reinstate this man page from v2.1.1.
create-local-instance(1) New Paul Jennifer Chou
Add this man page.
create-service(1) Moderate Paul Byron Nevins
Describe the behavior of the create-service command on Linux systems.
copy-config(1) Minor Paul Bhakti Mehta
Reinstate this man page from v2.1.1.
delete-cluster(1) Minor Paul Bhakti Mehta
Reinstate this man page from v2.1.1.
delete-instance(1) Minor Paul Byron Nevins
Reinstate this man page from v2.1.1.
delete-local-instance(1) New Paul Byron Nevins
Add this man page.
delete-config(1) Minor Paul Bhakti Mehta
Reinstate this man page from v2.1.1.
export-sync-bundle(1) New Paul Jennifer Chou
Add this man page.
import-sync-bundle(1) New Paul Jennifer Chou
Add this man page.
list-configs(1) Minor Paul Bhakti Mehta
Reinstate this man page from v2.1.1.
list-clusters(1) Minor Paul Bhakti Mehta
Reinstate this man page from v2.1.1.
list-instances(1) Minor Paul Byron Nevins
Reinstate this man page from v2.1.1.
list-jndi-entries(1) Minor
Paul
Jagadish Ramu
Cheng Fang
Reinstate the description of the target operand.
restart-domain(1) Minor
Paul
Byron Nevins
Add a description of the --debug option.
restart-local-instance(1)
New
Paul
Byron Nevins
Add this man page.
restart-instance(1)
New
Paul
Byron Nevins
Add this man page.
start-cluster(1) Minor Paul Joe Di Pol
Reinstate this man page from v2.1.1.
start-instance(1) Minor Paul Carla Mott
Reinstate this man page from v2.1.1.
start-local-instance(1) New Paul Byron Nevins
Add this man page.
stop-cluster(1) Minor Paul Joe Di Pol
Reinstate this man page from v2.1.1.
stop-instance(1) Minor Paul Byron Nevins
Reinstate this man page from v2.1.1.
stop-local-instance(1) New Paul Byron Nevins
Add this man page.

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 changes    
High Availability Administration Guide changes    
Domain File Format Reference changes    
Add-On Component Development Guide changes    
Online help changes    
Man page changes October 25th, 2010 November 1st, 2010

Reviewers are listed in the Statement of Work.

Related Information

Email aliases: