GlassFish - World's first Java EE 7 Application Server


<h1>Administration Infrastructure Documentation Plan</h1>

People and Roles

Name Role Location Time Zone Email
June Parks Documentation Feature Owner     java.netID@dev.java.net
Man page team Dixie Pine Chinmayee Srivathsa Kim Haase Paul Davies Additional Writers     java.netID@dev.java.net
Julie Bettis Editor     java.netID@dev.java.net
Kedar Mhaswade Nandini Ektare Software Engineers     java.netID@dev.java.net
Sankar Neelakandan QA Engineer     java.netID@dev.java.net

Audience

The administration infrastructure is mostly hidden from the average user, but there are some user-visible administrative features. Advanced users may want to view or edit the domain.xml file, in which the administration infrastructure is stored.

Summary of the Feature From a User's Perspective

The average user will see the administration infrastructure mainly in the Administration Console and the asadmin commands, which are covered in the doc plans for the Administration Console online help and the man pages. Advanced users will see the infrastructure in the domain.xml file, which is covered in the Domain File Format Reference doc plan. Special features for administering the infrastructure itself are described in this plan.

Availability

The administration infrastructure is present in every distribution of the GlassFish server, but the embedded version does not include a user-editable domain.xml file.

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
To Start a Domain To Stop a Domain To Restart a Domain Moderate Dixie Pine Byron Nevins Changes correspond to *-domain man pages.

Upgrade Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
HTTP Service to Network Service Changes Minor Chinmayee Srivathsa Jean-Francois Arcand Justin Lee Section needs to be moved from the Release Notes.

Add-on Component Development Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Extending the domain.xml File NEW Paul Davies Kedar Mhaswade Nandini Ektare Description of the impact of new add-ons on the domain.xml file, cross reference to the Domain File Format Reference.

Domain File Format Reference Changes

Feature Documentation Impact Writer Reviewers Description of Change
DTD-like domain.xml schema MAJOR June Parks Nandini Ektare Tim Quinn Needed to be able to write the Domain File Format Reference at all. So far, Tim Quinn's tool is best.
domain element version attribute Minor June Parks Kedar Mhaswade Nandini Ektare New attribute description.
Grizzly changes NEW June Parks Jean-Francois Arcand Justin Lee See the Grizzly feature doc plan.
Deployment changes NEW June Parks Tim Quinn Hong Zhang Most user-visible deployment features are unchanged. See the Deployment specification.
JDBC/JCA changes NEW June Parks Jagadish Prasad Ramu Shalini Muthukrishnan See the JDBC and Connectors feature doc plan.
domain.xml minimization Minor June Parks Kedar Mhaswade Nandini Ektare Add a note to Defaults section.
domain.xml backup Minor June Parks Kedar Mhaswade Nandini Ektare New section.

Changes to Online Help

Administration Console Changes

Topic Title Documentation Impact Writer Reviewers Description of Change
All topics Moderate Kim Haase Various Configuration changes are reflected in the Administration Console, but administration of the infrastructure itself is not.

Changes to Man Pages

Man Page Name and Section Documentation Impact Writer Reviewers Description of Change
verify-domain-xml Minor June Parks Nandini Ektare Command usage won't change, output might.
create-service Moderate Paul Davies Byron Nevins Multiple platform support.
restart-domain NEW Paul Davies Byron Nevins New server restart feature.
start-domain Moderate Paul Davies Byron Nevins Changed or new options are --alwaysrestart, --watchdog, and --verbose.
stop-domain Moderate Paul Davies Byron Nevins Changed functionality to complement start-domain and restart-domain, stopping a runaway server.
Other commands Moderate Man page team Various Configuration changes are reflected in the man pages.

Review Schedule

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

Item First Draft Start Date First Draft End Date Second Draft Start Date Second Draft End Date Final Version End Date Final Version End Date
             
             
             

Reviewers are listed in the Statement of Work.

Related Information

Email aliases:

  • [admin@glassfish.java.net]
  • [users@glassfish.java.net]
  • [docs@glassfish.java.net]