Chapter 2 Upgrading an Application Server Installation

The Upgrade Tool, which is bundled with Sun GlassFish^TM Enterprise Server v3 (Enterprise Server v3), replicates the configuration of a previously installed server in the target installation. The Upgrade Tool assists in upgrading the configuration and applications from an earlier version of the Application Server or Enterprise Server to Enterprise Server v3. To view a list of the older versions from which you can upgrade, see Table 2–1.

The following topics are addressed here:

• Upgrade Overview

• Performing an Upgrade

The Upgrade Tool is different from the Update Tool, which allows you to add or update components of Enterprise Server v3. For more information about the Update Tool, see Update Tool in Sun GlassFish Enterprise Server v3 Administration Guide.

Upgrade Overview

Table 2–1 shows supported upgrade paths.

Enterprise Server v3 does not support clustering. Therefore, upgrading from the Enterprise Profile is not supported.

Upgrade Tool Interfaces

You can use the tool through the command-line interface (CLI) or the GUI.

• To use the Upgrade Tool in GUI mode, issue the asupgrade command with no options. See To Upgrade by Using the Upgrade Tool Wizard for details.

• To run the Upgrade Tool in CLI mode, invoke the asupgrade command with the -c/--console option. See To Upgrade From the Command Line for more details.

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 Domains Root Directory

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

Master Password

The SSL certificate database password used in operations such as Enterprise 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.

Upgrade Tool Functionality

The Upgrade Tool migrates the configuration and deployed applications from an earlier version of the Application Server or Enterprise Server to the current version. The Upgrade Tool does not upgrade the binaries of the server. The installer is responsible for upgrading the binaries. Database migrations or conversions are also beyond the scope of this upgrade process.

Before starting the upgrade process, make sure that you stop all domains in the source server (the server from which you are upgrading) and the target server (the server to which you are upgrading).

Migration of Deployed Applications

Application archives (EAR files) and component archives (JAR, WAR, and RAR files) that are deployed in the source server do not require any modification to run on Sun GlassFish Enterprise Server v3. Components that may have incompatibilities are deployed on Enterprise Server v3 with the compatibility property set to v2 and will run without change on Enterprise Server v3. You may, however, want to consider modifying the applications to conform to Java EE 6 requirements..

The Java EE 6 platform specification imposes stricter requirements than Java EE 5 did on which JAR files can be visible to various modules within an EAR file. In particular, application clients must not have access to EJB JAR files or other JAR files in the EAR file unless they use a Class-Path header in the manifest file, or unless references use the standard Java SE mechanisms (extensions, for example), or use the Java EE library-directory mechanism. Setting this property to v2 removes these Java EE 6 restrictions.

Applications and components that are deployed in the source server are deployed on the target server during the upgrade. Applications that do not deploy successfully on the target server must be deployed manually on the target server by the user.

If a domain contains information about a deployed application and the installed application components do not agree with the configuration information, the configuration is migrated as is without any attempt to reconfigure the incorrect configurations.

Upgrade Verification

An upgrade log records the upgrade activity. The upgrade log file is named upgrade.log and is created in the working directory from which the Upgrade Tool is run. Additional information is recorded in the server log of the upgraded domain.

Performing an Upgrade

When you use the Upgrade Tool, the source server and the target server are normally installed on the same machine, but under different install locations. Both server file systems must be accessible from the system on which you perform the upgrade.

The Upgrade Tool upgrades your server configuration and deployed applications.

To perform the upgrade, the user who runs the upgrade needs to have Read permissions for the source and target directories and Write permission for the target directory.

Ensure that you have stopped all domains in the source server before you start the upgrade process.

There are two ways to upgrade your server installation:

• To Upgrade From the Command Line

• To Upgrade by Using the Upgrade Tool Wizard

To Upgrade From the Command Line

To run Upgrade Tool in command-line mode, use the -c option. You can run the upgrade tool in command-line mode using the following syntax:

asupgrade 
[--console] 
[--version] 
[--help] 
[--source previous-server-installation-domaindirectory] 
[--target enterprise-server-v3-installation] 
[--masterpassword mpassword]
[--passwordfile password-file]

Table 2–2 describes the command options in greater detail, including the short form, the long form, and a description.

The following example shows how to use the asupgrade command-line utility to upgrade an existing Sun GlassFish Enterprise Server v2.1 installation to Enterprise Server v3.

asupgrade -c --source /home/glassfish/domains/domain1 --target /home/glassfishv3/glassfish/domains

If you invoke the tool only with the -c/--console option, the tool enters the interactive CLI mode, where you are asked to supply the needed options.

After you issue the asupgrade command, the tool informs you that domain1 already exists in the target directory and asks if you would like to rename it. If you type y, the directory is renamed domain1.original. If domain1.original already exists, the directory is named domain1.original.0.

To Upgrade by Using the Upgrade Tool Wizard

1. Start the wizard as follows.

   • On a UNIX system, change to the as-install/bin directory and type asupgrade.

   • On a Windows system, double-click the asupgrade.bat icon in the as-install/bin directory.

2. In the Source Domain Directory field, type the domain directory of the existing installation from which to import the configuration, or click Browse.

   For example, you might type c:\glassfish\domains\domain1.

3. In the Target Domains Root Directory field, type the location of the Enterprise Server v3 installation to which to transfer the configuration, or click Browse.

   The default is the full path name of the domains directory of your Enterprise Server v3 installation (for example, c:\glassfishv3\glassfish\domains).

4. (Optional) Provide the master password of the source application server.

   The domain will be upgraded using these credentials.

5. Click Next.

   A dialog box informs you that domain1 already exists in the target directory and asks if you would like to rename it. If you click OK, the directory is renamed domain1.original. If domain1.original already exists, the directory is named domain1.original.0.

6. The Upgrade Results page displays the status of the upgrade operation.

7. Click Finish to exit the Upgrade Tool when the upgrade process is complete.

Next Steps

After you complete the upgrade, start the Enterprise Server using the asadmin start-domain command. Log in to the Administration Console with the user name and password you used in the older server.

To register your installation of Enterprise Server from the Administration Console, select the Registration node. For step-by-step instructions on the registration process, click the Help button on the Administration Console.

Visit the URL http://localhost:8080 to view the domain-dir/docroot/index.html file. This file is brought over during the upgrade. You may want to copy the default Enterprise Server v3 file from the domain1.original/docroot directory and customize it for your Enterprise Server v3 installation.