<h1>GlassFish v3 Administration Guide Document Plan</h1>

People and Roles

Audience

The primary user of the Administration Guide is the person who is managing the Enterprise Server for an organization. Due to the complexity of the product, this is not a novice system administrator. Secondary user is a developer who might be charged with performing administration tasks.

Purpose and Description

The purpose of the Administration Guide is to provide command-line instructions for administering the Enterprise Server after it has been installed or upgraded. Included:

• An overview of administration tasks
• Instructions for using the asadmin command-line tool to accomplish administrator tasks
• Examples and links to asadmin man pages
• Links to the graphical Administration Console online help pages whenever possible
• Instructions for using the Administration Console if there is no way to perform the task using an asadmin command
• Instructions and examples for using the security keytool and certutil utilities
• Roadmap to using other related docs in the collection, such as Application Deployment Guide, Developer's Guide, Administration Reference, High Availability Administration Guide

Note: An assumption for GFv3 (not TP2, Prelude, or Preview) is that there will be parity between the asadmin commands and the Administration Console.

Statements of Work

There are four major delivery milestones for GlassFish v3 documentation: TP2, Prelude, Preview, FCS. This section describes each release and it's specific contents.

TP2 Statement of Work

The TP2 Administration Guide will contain only that material specified by engineering as part of the JavaONE Technology Preview (TP2) release. Using the 9.1 Administration Guide as a base, I will hide all the material that is not for TP2, write new material needed for TP2, apply any changes in terminology/versioning, and reorganize the manual as needed for coherency. A task-based approach will be implemented. One technical review will occur before delivery with 100% of feedback incorporated. If time allows, a peer review and a developmental edit will also be done.

TP2 Administration Features

• JDBC material
• Web Container material
• Users/Groups/Roles/Reams material
• Certificates and SSL material for JSSE
• HTTP configuration material
• Logging configuration material
• asadmin commands that will be included (from CLI Commands Doc Plan list):

• deploy/undeploy,redeploy (no java2db)
• enable/disable
• backup-domain (NTH)
• change-admin-password (NTH)
• create/delete-ssl
• create/delete/list-auth-realm
• create/delete/list-domain
• create/delete/update/list-file-user
• get/set/list
• help
• start-domain/stop-domain
• create/delete/list-jdbc-connection-pool (RSR)
• create/delete/list-jdbc-resource (RSR)
• create/delete/list-http-listener (RSR)
• create/delete/list-virtual-server
• ping-connection-pool
• create/delete/list-jvm-options (RSR)
• create/delete-profiler
• add-resources (RSR)
• start-database/stop-database
• version
• list-applications, list-commands, list-components, list-containers, list-modules
• create/delete/list-system-properties (NTH)

TP2 Table of Contents

• Ch. 1 About Application Server Administration---Intro to admin tasks, tools, files, Administration Console, asadmin utility. Includes overview of Application Server.
• Ch. 2 Basic Administration---Intro, domains, resources properties, lists
• Ch. 3 Administering the JVM---Intro, JVM options, profilers
• Ch. 4 Administering Database Connectivity---Intro, database set up, connection pools, resources, JDBC drivers
• Ch. 5 Administering System Security---Intro, firewalls, passwords, JSSE certificates
• Ch. 6 Administering User Security---Intro, file users, authentication realms
• Ch. 7 Administering the HTTP Service---Intro, HTTP listeners, virtual servers
• Ch. 8 Administering Logging---Intro, settings
• App. A The asadmin Utility Commands---List of the administration commands that apply to the release.

Prelude Statement of Work

Prelude is a formal release of the TP2 functionality, essentially a v3 Lite or developer release. The Administration Guide will be based on the TP2 version, plus some additional functionality.

Prelude Administration Features
Two additional pieces of functionality will expand the TP2 features: monitoring and plugins. Administration tasks for plugins are fairly limited because most plugin work is for developers. Text in the Administration Guide might be limited to overview description of plugins and links to the developer docs. Some asadmin commands will be added; some TP2 commands/man pages will be reworked.

Prelude Table of Contents

• Ch. 1 About Application Server Administration---Intro to admin tasks, tools, files, Admin Console, asadmin utility. Includes overview of Application Server. ** ADD Explain where to go for instructions on doing additional admin-type work, such as getting started, installation, performance tuning, plugins, deploying apps, troubleshooting, upgrading.%%
• Ch. 2 Basic Administration---Intro, domains, resources, properties, lists
• ADD Ch. 3 Extending & Updating Enterprise Server---Intro, install, update, uninstall add-on components using pkg command.%%
• Ch. 4 Administering the JVM---Intro, JVM options, profilers
• Ch. 5 Administering Database Connectivity---Intro, database set up, connection pools, resources, JDBC drivers
• Ch. 6 Administering System Security---Intro, firewalls, passwords, audit modules, JSSE certificates. Reorganize JSSE material as tasks.
• Ch. 7 Administering User Security---Intro, file users, authentication realms
• ADD Ch. 8 Administering the Transaction Service---%%
• Ch. 9 Administering the HTTP Service---Intro, HTTP listeners, virtual servers
• ADD Ch. 10 Administering Logging---Intro, instructions for configuring with logging.properties file.%%
• ADD Ch. 11 Monitoring Enterprise Server %%
• App. A The asadmin Utility Commands---List of the administration commands that apply to the release.
  • ADD monitor%%
  • ADD change-master-password%%
  • ADD create-audit-module%%
  • ADD list-audit-modules%%
  • ADD delete-audit-module%%
  • ADD list-file-groups%%
  • ADD uptime%%

• ADD App. B Monitoring Statistics (maybe move from ch. 11)%%

Preview for JavaONE Statement of Work

For Preview, chapters on the following topics will be added to the Prelude Administration Guide:

• Connectors
• Message Security
• JMS
• JavaMail
• ORB

Tasks will be written for the corresponding asadmin commands. Other additions: password allias commands (System Security ch), monitoring for JDBC connection pools (Monitoring chapter). Some material is from v2, most is new. All deployment commands will be moved to the Application Deployment Guide.

FCS Statement of Work

For FCS, full content of the Administration Guide will be available in task-based form, based on the JavaONE Preview version and pulling in much of the GF2 material that was still hidden for Prelude and Preview. All features, functionality, and tasks will be represented. 100% of editorial and reviewer comments will be implemented. There will be no outstanding P1-P3 bugs against the manual.

FCS Table of Contents

• Ch.1 Overview of Enterprise Server Administration---Introduction to admin tasks, configuration, tools.

Section 1 Runtime Administration

• General Administration---asadmin, system properties, create resource, list various
• Administering Domains---domains, instances, profiles
• Administering the JVM---JVM options, profilers.
• ADD Administering Thread Pools%%
• ADD Administering Web Applications%%
• Administering the Logging Service
• Administering the Monitoring Service
• ADD Administering Life Cycle Modules%%
• Extending Enterprise Server---overview of Update Tool; using pkg command

Section 2 Security Administration

• Administering System Security---overview, passwords, audit modules, JSSE certs
• Administering User Security---file users, groups, role, realms
• Administering Message Security---providers, protection policies

Section 3 Resources and Services Administration

• Administering Database Connectivity---database set up, connection pools, resources, JDBC drivers
• ADD Administering EIS Connectivity---connection pools, resources, resource adapters, connector security maps, administered objects

  Internet Connectivity---HTTP/network listeners, virtual servers

  • ADD Administering the ORB

    ---

    Jspwiki style: Administering

• ADD Administering JavaMail%%
• Administering JMS---destinations, connection factories, providers, hosts, MQ
• ADD Ch. Administering JNDI%%
• ADD Ch. Administering Transactions%%

Appendixes

• Appendix A The asadmin Utility Commands---List of the administration commands in this guide.

Reviewer Dashboard

Documentation schedule

The reviewers of this document are listed in the following table. Review comments should be added to the review wiki page: Administration Guide comments

Delivery Methods

The Administration Guide will be published on the docs.sun site in PDF and HTML.

Related Information

Previous versions of the Administration Guide:

• Application Server 9.1 Administration Guide
• GlassFish Enterprise Server v3 Prelude Administration Guide

Email aliases:

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