Sun GlassFish Web Space Server 10.0 Installation Guide

Using Update Tool

After installing the core Web Space Server 10.0 software, updates to Web Space Server and any plugins can be performed entirely through the Update Tool that is bundled with Web Space Server 10.0.


Note –

The version of Update Tool included with some versions of GlassFish Enterprise Server is not compatible with the Web Space Server update repositories. You must use the version of Update Tool that comes with Web Space Server 10.0 software rather than the version that is bundled with GlassFish .


Update Tool also includes a command-line (CLI) Image Packaging System (IPS) utility, called pkg, that provides the same core functionality as its GUI-based counterpart. This IPS tool is started with the ws-install-dir/bin/pkg command. See the Update Center wiki for complete information about Update Tool and the pkg command.

You can install Web Space Server 10.0 Update components through either the Update Tool GUI or with the pkg CLI utility.

ProcedureTo Determine the Current Web Space Server Version

Before installing a Web Space Server Update package, or when performing Web Space Server maintenance tasks in general, it is often useful to know the full version information about the currently running Web Space Server installation. This information can be displayed through Update Center, but the quickest and most complete information is found the Web Space Server version file.

  1. In a command shell, change to the ws-install-dir/var/webspace directory, and display the contents of the version.


    cd ws-install-dir/var/webspace
    less version
    

    For example, the following version information is returned for Web Space Server Update 5:


    Version=10.0.5
    Build=1.19
    Revisions=1626-31998-26479
    VanityVersion=Web Space Server 10.0 Update 5

ProcedureTo Install the Update Components Using the GUI-Based Update Tool

This procedure explains how to install an Update patch on top of an existing Web Space Server 10.0 installation using the GUI-based Update Tool. If you prefer to use the pkg command line tool, see To Install the Update Components Using the CLI-Based pkg Tool.

Before You Begin

Note the following before you begin the Update installation:

  1. In a command shell for your operating system, change to the ws-install-dir/bin directory and run the updatetool command.

    If this is the first time you have launched updatetool, the full Update Tool product will not yet be installed, and you are prompted to allow installation to proceed.

    1. Type y when prompted to install Update Tool.

      The installer downloads and installs the full Update Tool product and then exits.

    2. Enter the updatetool command again to launch Update Tool.

    The Update Tool main window is displayed, with Available Updates highlighted.

  2. (Optional) Specify proxy server settings, if necessary.

    This step is only required if you are using Update Tool from behind a firewall that implements a proxy server.

    1. Click Preferences in the Update Tool main window to display the proxy server settings dialog.

    2. Enter your proxy settings, and then close the dialog to return to the Update Tool main screen.

  3. Click the Web Space node in the Application Images pane on the left in Update Tool.

    Details about the currently selected software repositories are displayed. To get the Web Space Server updates, the update repository URL must be modified in this list.

  4. Click Edit Properties on the right side of the Image Details pane.

    The repositories displayed by default depend on the version of Web Space Server you are using.

    • If you are using Web Space Server Update 6:

      1. Select the webspace.sun.com repository in the Image Properties dialog, and then click Edit.

      2. In the Repository Properties dialog, modify the Repository URL so it reads:


        http://pkg.sun.com/webspace/10/_support_
      3. Click OK twice to return to the Update Tool main window.

    • If you are using Web Space Server Update 5 or earlier:

      1. Select the support.sun.com repository in the Image Properties dialog, and then click Edit.

      2. In the Repository Properties dialog, modify the Repository URL so it reads:


        http://pkg.sun.com/webspace/10/_support_
      3. Click OK twice to return to the Update Tool main window.

    • Verify that the support.sun.com repository is now Enabled and selected as Preferred.

  5. Back in the Update Tool main window, choose the Available Updates node in the Application Images pane to display the list of available Updates.

    The available updates and their associated WAR files are displayed. It is recommended that you always choose the latest available update.

  6. Select the Web Space Server update package you want to install, and then click Install to install the update.

  7. Restart the application server.

    For example, if running GlassFish Enterprise Server, use the following commands:


    cd gf-install-dir/bin
    ./asadmin stop-domain domain_name
    ./asadmin start-domain domain_name
    
  8. Change to the ws-install-dir/webspace/application directory.

  9. Run the Ant install.xml script to regenerate and redeploy the Web Space Server WAR files.


    ant -f install.xml
    
  10. Restart the application server once again.

    For example, if running GlassFish Enterprise Server:


    cd gf-install-dir/bin
    ./asadmin start-domain domain_name
    

ProcedureTo Install the Update Components Using the CLI-Based pkg Tool

This procedure explains how to install an Update patch on top of an existing Web Space Server 10.0 installation using the CLI-based pkg utility. If you prefer to use the GUI-based Update Tool, see To Install the Update Components Using the GUI-Based Update Tool.

Before You Begin

Note the following before you begin the Update installation:

  1. In a command shell for your operating system, change to the ws-install-dir/bin directory and run the updatetool command.

    If this is the first time you have launched updatetool, the full Update Tool product will not yet be installed, and you are prompted to allow installation to proceed.

  2. Type y when prompted to install Update Tool.

    The installer downloads and installs the full Update Tool product and then exits.

  3. Change to the ws-install-dir/pkg/bin directory.

  4. Use the pkg command to download the Update components.

    • If you are using Web Space Server Update 6, enter the following command:


      pkg set-publisher -O http://pkg.sun.com/webspace/10/_support_ webspace.sun.com
      
    • If you are using Web Space Server Update 5 or earlier, enter the following command:


      pkg set-authority -P --enable -O http://pkg.sun.com/webspace/10/_support_ support.sun.com
      
  5. Enter the following command to install the Update components:


    pkg image-update
    
  6. Restart the application server.

    For example, if running GlassFish Enterprise Server, use the following commands:


    cd gf-install-dir/bin
    ./asadmin stop-domain domain_name
    ./asadmin start-domain domain_name
    
  7. Change to the ws-install-dir/webspace/application directory.

  8. Run the Ant install.xml script to regenerate and redeploy the Web Space Server WAR files.


    ant -f install.xml
    
  9. Restart the application server.

    For example, if running GlassFish Enterprise Server:


    cd gf-install-dir/bin
    ./asadmin start-domain domain_name
    

ProcedureTo Use Update Tool With an Older Version of Web Space Server Behind a Proxy That Requires Authentication

When using Update Tool to upgrade a version of Web Space Server prior to Update 5, a workaround is required when performing the upgrade from behind a proxy server that requires authentication.

Before You Begin

The workaround presented here is only required when updating Web Space Server versions prior to Update 5. Web Space Server Update 5 and later are bundled with Update Center 2.2, which supports proxy authentication and therefore does not require this workaround. See To Determine the Current Web Space Server Version for instructions on displaying the current Web Space Server version.

  1. Download Update Center 2.2 package suitable for your platform from the Update Center wiki.

  2. Unzip the Update Center 2.2 package to the temporary directory of your choice.

    In this example, the temporary directory is named /tmp/uc2.2, and the package is for the Sun Solaris x86 operating environment.

  3. Copy the pkg-bootstrap.jar and pkg-client.jar files from /tmp/uc2.2/pkg-toolkit-platform_name/pkg/lib to the ws-install-dir/pkg/lib directory.

  4. Change to the ws-install-dir/bin directory and run the updatetool command.

    You are prompted to specify the proxy host and port.

  5. Enter the proxy information as prompted.

    The latest versions of the updatetool and pkg files are downloaded and installed.

  6. Run updatetool again, and proceed with the Web Space Server update, as described in To Install the Update Components Using the GUI-Based Update Tool or To Install the Update Components Using the CLI-Based pkg Tool.