Upgrade Overview

The subsections that follow provide information that you will need when you perform an upgrade.

The following topics are addressed here:

• Upgrade Paths

• Upgrade Terminology

• Summary of Upgrade Tools and Procedures

• Supported Releases for Upgrade to GlassFish Server 3.1

• Upgrading From Version 8.x or Older Product Releases

• Upgrading GlassFish Server Inside a Closed Network

Upgrade Paths

There are two general paths you can use when upgrading to GlassFish Server 3.1:

Side-by-Side

A side-by-side upgrade means that the new GlassFish Server release is installed in a different directory than the release from which you are upgrading.

In this scenario, you perform the following steps:

1. Perform a basic installation of GlassFish Server 3.1 in a location other than the one being used for the older product.

2. Use Upgrade Tool to migrate the old configurations and applications to the new GlassFish Server 3.1 directories.

3. Test the new GlassFish Server installation to make sure everything is working properly.

4. When you are satisfied that the new installation works properly, modify your production environment to use the new installation.

The side-by-side upgrade path is typically used for live production environments because it allows you to thoroughly test the new GlassFish Server installation before bringing it into production.

In-Place

An in-place upgrade means that the new GlassFish Server release is installed directly over and into the same directory as the previous product release. The existing configuration is reused in the updated installation.

In this scenario, you simply use Update Tool, the pkg utility, or the Update Notifier in your old installation to overwrite the old installation with the new GlassFish Server 3.1 product.

Performing an in-place upgrade is easier than performing a side-by-side upgrade, but you lose the ability to switch back and forth between the old and new installations. There is also no way to revert an in-place upgrade back to the previous product version. Because of these limitations, in-place upgrades are typically only used by developers and for non-production GlassFish Server deployments.

Note also that it is only possible to perform an in-place upgrade when upgrading from GlassFish Server 3.0.1 or v3. If you are upgrading from product versions prior to 3x, you must perform a side-by-side upgrade.

For a more detailed overview, see Summary of Upgrade Tools and Procedures.

Upgrade Terminology

The following are important terms related to the upgrade process.

Source Domain Directory

The directory of the server domain from which you are upgrading to the new version (for example, c:\glassfish\domains\domain1).

Target Root Domain's Directory

The directory where domains are created on the server to which you are upgrading (for example, c:\glassfish3\glassfish\domains).

Master Password

The SSL certificate database password used in operations such as GlassFish Server startup. This term refers to the master password of the installation from which you want to upgrade. You need to specify this password if you have changed it from the default value of changeit.

Summary of Upgrade Tools and Procedures

There are several tools you can use to upgrade from an earlier GlassFish Server or Enterprise Server installation to GlassFish Server 3.1. The general procedures for upgrading to GlassFish Server 3.1 vary depending on which tool you use and the product version from which you are upgrading.

The following topics are addressed here:

• Summary of Tools for Performing an Upgrade

• Summary of Procedure for Upgrading With Upgrade Tool

• Summary of Procedure for Upgrading With Update Tool

• Summary of Procedure for Upgrading With the Software Update Notifier

• Summary of Procedure for Upgrading With the pkg Utility

Summary of Tools for Performing an Upgrade

There are several tools you can use to perform an upgrade to GlassFish Server 3.1 are described below.

• Upgrade Tool

• Update Tool and the pkg Utility

• Software Update Notifier

Upgrade Tool

The GlassFish Server Upgrade Tool is tended solely for performing side-by-side upgrades from any compatible older product version to GlassFish Server 3.1.

Upgrade Tool provides a number of features that aid in the migration of older configurations and applications to a new GlassFish Server 3.1 installation. These features are described in more detail in Upgrade Tool Functionality.

In GlassFish Server 3.1 Upgrade Tool is installed in the as-install-parent/glassfish/bin directory.

See Summary of Procedure for Upgrading With Upgrade Tool for an overview of the general procedure for performing an upgrade with Upgrade Tool.

Update Tool and the pkg Utility

The GlassFish Server Update Tool is a graphical utility that is typically used for the day-to-day maintenance of GlassFish Server components and additional features. For example, Update Tool can be used to update GlassFish Server components or install additional features such as OSGi Admin Console.

The command-line counterpart to Update Tool is the pkg utility. While the pkg utility does not provide exactly the same set of features as Update Tool, for the purposes of upgrading to GlassFish Server 3.1, the pkg utility and Update Tool feature sets are almost identical.

In addition to day-to-day maintenance tasks, Update Tool and the pkg utility can be used to perform an in-place upgrade of an entire GlassFish Server 3.0.1 or Enterprise Server v3 installation to the GlassFish Server 3.1 or later release.

In GlassFish Server 3.1 Update Tool is installed in the as-install-parent/bin directory.

See Summary of Procedure for Upgrading With Update Tool for an overview of the general procedure for performing an upgrade with Update Tool. For more information about Update Tool in general, see Update Tool in Oracle GlassFish Server 3.1 Administration Guide.

Software Update Notifier

The GlassFish Server Software Update Notifier is similar to Update Tool and the pkg utility in that it enables you to perform an in-place upgrade from GlassFish Server 3.0.1 or Enterprise Server v3. As with Update Tool and the pkg utility, you cannot use the Software Update tool to upgrade from product releases prior 3.0.1 and v3.

The Software Update Notifier is distributed as a configuration option during GlassFish Server 3.1, 3.0.1, and Enterprise Server v3 installation. If installed and enabled, the Software Update Notifier monitors your installation and pops up a notification balloon when updates or upgrades are available for your product.

See Summary of Procedure for Upgrading With the Software Update Notifier for an overview of the general procedure for performing an upgrade with the Software Update Notifier. For more information about the Update Notifier, refer to the Update Tool online help.

Summary of Procedure for Upgrading With Upgrade Tool

The general procedure for using Upgrade Tool to perform an upgrade to GlassFish Server 3.1 from any compatible older version of GlassFish Server or Enterprise Server comprises the following steps:

1. Download GlassFish Server 3.1 and perform a Standard Installation, as described in To Install GlassFish Server Using the Self-Extracting File in Oracle GlassFish Server 3.1 Installation Guide.

2. Copy any custom or third-party libraries from the older installation to their corresponding locations in the new GlassFish Server 3.1 installation directories. Note that you should only copy custom or third-party libraries here. Do not copy an libraries from the actual domain that will be upgraded.

3. Run the asupgrade command from the new GlassFish Server 3.1 as-install-parent/glassfish/bin directory.

4. Start the new GlassFish Server 3.1 DAS with the asadmin start-domain subcommand.

This procedure is described in more detail in Performing a Side-By-Side Upgrade With Upgrade Tool.

Summary of Procedure for Upgrading With Update Tool

The general procedure for using Update Tool to perform an upgrade to GlassFish Server 3.1 from GlassFish Server 3.0.1 or Enterprise Server v3 comprises the following steps:

1. Manually stop all server instances and the domain.

2. Launch Update Tool by using the as-install-parent/bin/updatetool command in the older product directory.

3. In Update Tool, select and install the latest GlassFish Server product release. This updates your server to the 3.1 release.

4. Upgrade the domain by running the asadmin start-domain --upgrade subcommand. This performs the upgrade and then shuts down the DAS.

5. Restart the DAS normally with the with the asadmin start-domain subcommand.

This procedure is described in more detail in To Upgrade Using the Update Tool GUI.

Summary of Procedure for Upgrading With the Software Update Notifier

The general procedure for using the Software Update Notifier to perform an upgrade to GlassFish Server 3.1 from GlassFish Server3.0.1 or Enterprise Server v3 comprises the following steps:

1. Wait for the Software Update Notifier to pop up a notification balloon informing you that updates are available.

2. Click the balloon prompt to launch the Software Update GUI.

3. Manually stop all server instances and the domain.

4. Use the Software Update GUI to perform the upgrade. This updates your server to the 3.1 release.

5. Upgrade the domain by running the asadmin start-domain --upgrade subcommand. This performs the upgrade and then shuts down the DAS.

6. Restart the upgraded DAS normally with the with the asadmin start-domain subcommand.

This procedure is described in more detail in To Upgrade Using the Software Update Notifier.

Summary of Procedure for Upgrading With the pkg Utility

The general procedure for using the pkg utility to perform an upgrade to GlassFish Server 3.1 from GlassFish Server3.0.1 or Enterprise Server v3 comprises the following steps:

1. Manually stop all server instances and the domain.

2. Run the as-install-parent/bin/pkg command with the desired options in the older product directory. This updates your server to the 3.1 release.

3. Upgrade the domain by running the asadmin start-domain --upgrade subcommand. This performs the upgrade and then shuts down the DAS.

4. Restart the upgraded DAS normally with the with the asadmin start-domain subcommand.

This procedure is described in more detail in To Upgrade From the Command Line Using the pkg Utility.

Supported Releases for Upgrade to GlassFish Server 3.1

Upgrades to GlassFish Server 3.1 are supported from the following earlier GlassFish Server product releases:

• Sun Java System Application Server 9.1 Update 2

• Sun GlassFish Enterprise Server v2.1

• Sun GlassFish Enterprise Server v2.1.1

• Sun GlassFish Enterprise Server v3

• Oracle GlassFish Server 3.0.1

Upgrading From Version 8.x or Older Product Releases

It is not possible to upgrade to GlassFish Server 3.1 directly from Sun GlassFish Enterprise Server 8.x or older product releases.

To upgrade from a product release that is older than any of those listed in Supported Releases for Upgrade to GlassFish Server 3.1, you must first upgrade your older product release to one of the releases that are supported for upgrade to GlassFish Server 3.1.

For example, to upgrade from any Enterprise Server 8.x release, you first need to upgrade that older release to Enterprise Server 2.1.1. That is, your upgrade path would be as follows:

Enterprise Server 8.x⇒Enterprise Server 2.1.1⇒GlassFish Server 3.1

Sun GlassFish Enterprise Server 2.1.1 is available for download from the GlassFish Community Downloads page. Instructions for upgrading to Enterprise Server 2.1.1 are provided in the Sun GlassFish Enterprise Server 2.1.1 Upgrade Guide.

After upgrading your older Enterprise Server installation to Enterprise Server 2.1.1, you can proceed normally with the instructions in this guide to complete the upgrade to GlassFish Server 3.1.

Upgrading GlassFish Server Inside a Closed Network

For instructions on upgrading a GlassFish Server installation in an environment where Internet access is not available, see Extending and Updating GlassFish Server Inside a Closed Network in Oracle GlassFish Server 3.1 Administration Guide.