GlassFish - World's first Java EE 7 Application Server


GMS Runtime Clustering and GMS Configuration 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
Joe Fialli
Software Engineer Burlington, MA, USA
US/Eastern jfialli@dev.java.net
Bobby Bissett
Software Engineer Burlington, MA, USA US/Eastern bbissett@dev.java.net
Kazem Ardekanian QA Engineer Menlo Park, CA, USA
US/Pacific ka99118@dev.java.net

Audience

The Group Management System (GMS) Runtime Clustering feature and the GMS Configuration feature are aimed at system administrators.

Summary of the Feature From a User's Perspective

The GMS Runtime Clustering feature enables GlassFish Server instances to participate in a cluster.

The GMS Configuration feature enables GMS configuration data to to be stored.

Availability

The GMS Runtime Clustering feature and the GMS Configuration feature are 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
GMS Statistics in Chpater 8, Administering the Monitoring Service New Paul Joe Fialli
Bobby Bissett
DEFERRED TO 3.2

Add a description of the following statistics:
  • message throughput
  • thread utilitization
  • number of detect SUSPECTED
  • number of FAILURES

High Availability Administration Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Configuring GMS
Moderate Paul Joe Fialli
Bobby Bissett
Reinstate the GMS Failure Detection Settings section from the v2.1.1 documentation and update the attribute or property names to their new attribute names for release 3.1.

Add a description of the verify-failure-connect-timeout-in-millis attribute, which is absent from the v2.1.1 documentation.

Explain how to use the CLI to perform the following tasks:
  • Set the multicast address and port for a group
  • Set the IP address of the network interface on a multihome machine
  • Enable GMS
  • Disable GMS
  • Configure failure detection settings
  • Configure GMS cluster settings using create-cluster
  • Determine the operational state of a cluster using get-health
  • Determine if multicast is enabled for a cluster using validate-multicast

Upgrade Guide Changes

Scenario numbers refer to Instance Lifecycle Scenarios.

Section Documentation Impact Writer Reviewers Description of Change
Chapter 1. GlassFish Server Compatibility Issues New Paul
Joe Fiallil
Bobby Bissett 		Add a description of the transformations of cluster, group-management-service, and related elements in domain.xml after an upgrade from GlassFish v2.

Domain File Format Reference Changes

Section Documentation Impact Writer Reviewers Description of Change
Element Hierarchy Minor Paul Joe Fialli
Bobby Bissett 		Reinstate group-management-service.

Add failure-detection subelement.
cluster Minor Paul Joe Fialli
Bobby Bissett 		Move gms-bind-interface-address property to Attributes section.

Change cluster attribute names as follows:
  • heartbeat-enabled changed to gms-enabled
  • heartbeat-address changed to gms-multicast-address
  • heartbeat-port changed to gms-multicast-port
config Minor Paul Joe Fialli
Bobby Bissett 		Add group-management-service to the list of subelements.
failure-detection New
Paul Joe Fialli
Bobby Bissett 		Add a description of the failure-detection element. Most group-management-service attributes and properties are moving here.
group-management-service Moderate Paul Joe Fialli
Bobby Bissett 		Reinstate from the v2.1.1documentation.

Add failure-detection to the list of subelements.

Change the failure-detection-tcp-retransmit-timeout property to the failure-detection attribute verify-failure-connect-timeout-in-millis.

Change the following attributes:
  • ping-protocol-timeout-in-millis changed to group-discovery-timeout-in-millis, default changed to 5000
  • fd-protocol-max-tries changed to max-missed-heartbeats and moved to failure-detection
  • fd-protocol-timeout-in-millis changed to heartbeat-frequency-in-millis and moved to failure-detection
  • vs-protocol-timeout-in-millis changed to verify-failure-waittime-in-millis and moved to failure-detection
module-log-levels New
Paul Joe Fialli
Bobby Bissett 		Reinstate the description of the group-management-service attribute.

Changes to Online Help

All changes to online help, including those arising from the GMS Runtime Clustering and GMS Configuration features, are detailed in Administration Console Documentation Plan.

Changes to Man Pages

Man Page Name and Section Documentation Impact Writer Reviewers Description of Change
get-health(1)
Minor Paul Joe Fialli
Reinstate this man page from the v2.1.1 documentation.
validate-multicast(1) New
Paul
Bobby Bissett
Write the man page for this subcommand, which determines whether multicast is enabled for a cluster.

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    
Upgrade Guide changes    
Domain File Format Reference changes    
Online help changes    
Man page changes    

Reviewers are listed in the Statement of Work.

Related Information

Email aliases: