Deployment Documentation Plan for GlassFish Server Open Source Edition 3.1
People and Roles
| Name |
Role |
Location |
Time Zone |
Email |
| Rebecca Parks |
Documentation Feature Owner |
Santa Clara, CA, USA |
US/Pacific |
junesm@dev.java.net |
| |
Additional Writer |
|
|
java.netID@dev.java.net |
| |
Peer Reviewer |
|
|
java.netID@dev.java.net |
| Hong Zhang |
Software Engineer |
Burlington, VT, USA |
US/Eastern |
java.netID@dev.java.net |
| Tim Quinn |
Software Engineer |
Itasca, IL, USA |
US/Central |
java.netID@dev.java.net |
| Elena Asarina |
QA Engineer |
Santa Clara, CA, USA |
US/Pacific |
java.netID@dev.java.net |
Audience Both administrators and developers deploy applications, so this feature is of interest to all users. Some topics, such as rolling upgrade, are of primary interest to administrators, while others, such as deployment descriptors, are of primary interest to developers. Summary of the Feature From a User's Perspective The following deployment enhancements are planned for this 3.1 release:
- Clustering deployment, support dynamic deployment to cluster and rolling upgrade (parity with 2.1)
- Support application related commands in clustering environment (parity with 2.1)
- Partial support for Weblogic deployment descriptors in GlassFish (new)
- Rename sun-specific deployment descriptor dtds from sun-.dtd to glassfish-.dtd (new)
- Application versioning, support deployment of applications with multiple versions (new)
Availability The deployment featutre is available in the Web Profile distribution and the Full Platform distribution, but deployment of some types of components is possible only with 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 The renaming of deployment descriptors applies to the entire GlassFish Server documentation set but is minor, basically a search-and-replace operation. Old and new file names are listed in the following table.
| Old 3.0.1 Name |
New 3.1 Name |
Top-Level Element |
| sun-application.xml |
glassfish-application.xml |
glassfish-application |
| sun-application_6_0-0.dtd |
glassfish-application_6_0-1.dtd |
glassfish-application |
| sun-web.xml |
glassfish-web.xml |
glassfish-web-app |
| sun-web-app_3_0-0.dtd |
glassfish-web-app_3_0-1.dtd |
glassfish-web-app |
| sun-ejb-jar.xml |
glassfish-ejb-jar.xml |
glassfish-ejb-jar |
| sun-ejb-jar_3_1-0.dtd |
glassfish-ejb-jar_3_1-1.dtd |
glassfish-ejb-jar |
| sun-cmp-mappings.xml |
sun-cmp-mappings.xml |
Unchanged |
| sun-cmp-mapping_1_2.dtd |
sun-cmp-mapping_1_2.dtd |
Unchanged |
| sun-application-client.xml |
glassfish-application-client.xml |
glassfish-application-client |
| sun-application-client_6_0-0.dtd |
glassfish-application-client_6_0-1.dtd |
glassfish-application-client |
| sun-acc.xml |
sun-acc.xml |
Unchanged |
| sun-application-client-container_1_2.dtd |
sun-application-client-container_1_2.dtd |
Unchanged |
| sun-resources.xml |
glassfish-resources.xml |
Unchanged |
| sun-resources_1_4.dtd |
glassfish-resources_1_5.dtd |
Unchanged |
- Note -* Mitesh Meswani, the engineer assigned to CMP, says that the sun-cmp-mapping* files may not change, because CMP is an old and seldom-used feature.
Application Deployment Guide Changes
| Section |
Documentation Impact |
Writer |
Reviewers |
Description of Change |
| 1 Overview of Deployment |
Moderate |
Rebecca Parks |
Hong Zhang Tim Quinn |
Deployment to clusters and rolling upgrade reinstated from v2, new application versioning section. |
| 2 Deploying Applications |
Minor |
Rebecca Parks |
Hong Zhang Tim Quinn |
New redeploy --keep-state option (spelling uncertain) applies to HTTP session and SFSB/timer state saving. No other changes to deployment of specific module types expected. |
| A asadmin Deployment Subcommands |
Minor |
Rebecca Parks |
Hong Zhang Tim Quinn |
The create-application-ref, delete-application-ref, and list-application-refs commands will be reinstated from v2, and other deployment commands will have their --target options reinstated. New redeploy --keep-state option (spelling uncertain). |
| B Deployment Descriptor Files |
Major |
Rebecca Parks |
Hong Zhang Tim Quinn |
Add WebLogic deployment descriptors, including supported elements, with links to WebLogic docs. Change GlassFish deployment descriptor names. |
| C Elements of Deployment Descriptors |
Minor |
Rebecca Parks |
Hong Zhang Tim Quinn |
Few GlassFish deployment descriptor changes are expected aside from sun- to glassfish- top-level element name changes. |
Changes to Online Help Administration Console Common Online Help Changes See the Administration Console Documentation Plan. Changes to Man Pages
| Man Page Name and Section |
Documentation Impact |
Writer |
Reviewers |
Description of Change |
| create-application-ref, delete-application-ref, and list-application-refs |
Minor |
Rebecca Parks |
Hong Zhang Tim Quinn |
Reinstated from v2. |
| deploy, undeploy, enable, disable, deploydir, redeploy, list-components, list-sub-components, show-component-status, list-applications, create-lifecycle-module, delete-lifecycle-module, list-lifecycle-modules |
Minor |
Rebecca Parks |
Hong Zhang Tim Quinn |
--target option reinstated from v2. |
| redeploy |
Minor |
Rebecca Parks |
Hong Zhang Tim Quinn |
New --keep-state option (spelling uncertain) applies to HTTP session and SFSB/timer state saving. |
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 |
| Application Deployment Guide |
|
|
| Deployment Online Help |
|
|
| Deployment Man Pages |
|
|
Reviewers are listed in the Statement of Work. Email aliases:
|
