Sun logo      Previous      Contents      Index      Next     

Sun Java Enterprise System 2003Q4 Installation Guide

Chapter 2
Preparing for Installation

This chapter describes the tasks and decisions you need to resolve before installing the Java Enterprise System software.

Before beginning the tasks in this chapter, you should be familiar with the information in "How Does the Java Enterprise System Installer Work?".

This chapter contains the following sections:


Installation Roadmap

To best prepare for Java Enterprise System installation, you should understand the general sequence of events that you will need to go through. In the following table, the basic installation tasks are listed in the left column and the location of the information needed to complete these tasks is listed in the right column.

Table 2-1  Installation Roadmap 

Task

Location of Information

Review the example deployment plans to determine if any of them meet your needs.

Decide how, where, and in what order to install component product.

"Installation Procedures for Specific Deployment Needs"

Check for components already installed on the machine.

"Checking for Existing Software"

If needed, upgrade component products.

Chapter 4, "Upgrading System Components"

Verify that the system is ready for installation.

"Verifying System Readiness"

Choose an installation mode.

"Choosing an Installation Mode"

Choose a configuration type.

"Choosing a Configuration Type"

Gather configuration data that will be required by the installer.

Chapter 3, "Gathering Installation and Configuration Information"

Run the installer, or set up a silent installation process and then run it.

NOTE This step may include installation-time configuring, depending on which component products you select.

Chapter 5, "Installing Software Using the Graphical Interface"

or

Chapter 6, "Installing Software Using the Text-Based Interface"

or

Chapter 7, "Installing Software in Silent Mode"

Complete post-installation configuration and start the component products.

Chapter 8, "Postinstallation Configuration and Startup"

Resolve any installation problems.

Chapter 9, "Troubleshooting Installation Problems"

If needed, run the uninstaller.

Chapter 10, "Uninstalling Software"

If needed, provision users.

Chapter 11, "Provisioning Organizations and Users"

If needed, set up Single Sign-on.

Chapter 13, "Configuring Single Sign-on"

If needed, make an installation image available.

Appendix F, "Setup Instructions for Network Installation"


Installation Procedures for Specific Deployment Needs

This guide describes an installation procedure that accommodates almost all Java Enterprise System deployments. However, certain deployments require slightly different or abbreviated procedures. The following sections describe the procedures for these deployments:

High Availability Using Sun Cluster Software

If your Java Enterprise System deployment plan calls for the installation of Sun Cluster to support a high availability solution, you perform the installation in two phases:

  1. Install, configure and start the Sun Cluster framework.
  2. Install and configure the appropriate agents and component products or third-party products.

Installing, Configuring and Starting the Sun Cluster Framework

  1. Determine which machines will be in the cluster.
  2. Verify that system requirements are met on each machine in the cluster.
  3. On each machine in the cluster, use the Java Enterprise System installer to install the Sun Cluster Core component with Minimal configuration.
  4. Configure and start the cluster, as described in the Sun Cluster 3.1 Software Installation Guide (http://docs.sun.com/doc/816-3388). When these instructions direct you to run the scinstall program, use the copy located at /usr/cluster/bin/scinstall.

Installing and Configuring Agents and Products

If your deployment plan call for high availability of a Sun ONE product, see Table 2-2 for installation information. If your deployment plan calls for high availability of some other product, acquire the agent supporting that product and install and configure it following the instructions in the appropriate Sun Cluster Data Service guide. One way to get agents for other products is from the Sun Cluster 3.1 Data Service 5/03 CD. The Data Service guides are available at http://docs.sun.com/coll/573.10.

Table 2-2 lists the Sun ONE products whose agents are provided in the Sun Cluster Agents for Sun ONE component. For each product, the table lists the HA (high availability) services available and summarizes the installation process for the services.

Table 2-2  High Availability Installation Summary of Sun Cluster Agents for Sun ONE  

Product

HA Service

Summary of Installation Process

Administration Server

Fail-over

Use Sun ONE Directory Server 5.2 Installation and Tuning Guide (http://docs.sun.com/doc/816-6697-10) as a guide to installation and configuration.

To install the necessary packages, run the Java Enterprise System installer on each node, installing Administration Server and Agents for Sun ONE with Minimal configuration.

During configuration, use a location on the cluster file system as the Server Root.

Application Server

Fail-over

Use Sun Cluster 3.1 Data Service for Sun ONE Application Server (http://docs.sun.com/doc/817-1530) as a guide to installation and configuration.

To install the necessary packages, run the Java Enterprise System installer on each node, installing Application Server and Agents for Sun ONE with Minimal configuration. When specifying installation directories, use a location on the node’s local file system for Application Server, and use locations on the cluster file system for Application Server’s Server Configuration and Product Location.

Calendar Server

Fail-over

Use “Setting Up a High Availability Configuration” in the Sun ONE Calendar Server Administrator’s Guide (http://docs.sun.com/doc/816-6708-10) as a guide to installation and configuration.

To install the necessary packages:

  • On the primary node, run the Java Enterprise System installer, installing Calendar Server and Agents for Sun ONE with Minimal configuration. When specifying installation directories, use a location on the cluster file system for Calendar Server.
  • On each other node, run the Java Enterprise System installer, installing Agents for Sun ONE with Minimal configuration. Also on each other node, use the pkgadd command to add the packages for these shared components: ICU, LDAPCSDK, NSPR, NSS and SASL. See Table 2-3 for information about the package names and locations for these components.

Directory Server

Fail-over

Use the Sun ONE Directory Server 5.2 Installation and Tuning Guide, (http://docs.sun.com/doc/816-6697-10) as a guide to installation and configuration.

To install the necessary packages, run the Java Enterprise System installer on each node, installing Directory Server and Agents for Sun ONE with Minimal configuration. When specifying installation directories, use a location on the cluster file system for Directory Server, Server Root.

Message Queue

Fail-over

Use Sun Cluster 3.1 Data Service for Sun ONE Message Queue (http://docs.sun.com/doc/817-1531) as a guide to installation and configuration.

To install the necessary packages, run the Java Enterprise System installer on each node, installing Message Queue and Agents for Sun ONE with Minimal configuration.

During configuration, use a location on each node’s local file system for static files and data, and use a location on the cluster file system for dynamic data.

Messaging Server

Fail-over

Use “Configuring High Availability Solutions” in the Sun ONE Messaging Server 6.0 Installation Guide (http://docs.sun.com/doc/816-6735-10) as a guide to installation and configuration.

To install the necessary packages, run the Java Enterprise System installer on each node, installing Messaging Server and Agents for Sun ONE with Minimal configuration. When specifying installation directories, use a location on the local file system for Messaging Server.

During configuration, use a location on the cluster file system for mailboxes.

Web Server

Fail-over

Use Sun Cluster 3.1 Data Service for Sun ONE Web Server (http://docs.sun.com/doc/817-1528) as a guide to installation and configuration.

To install the necessary packages:

  • On the primary node, run the Java Enterprise System installer, installing Web Server and Agents for Sun ONE with Minimal configuration. When specifying installation directories, use a location on the cluster file system for Web Server.
  • On each other node, run the Java Enterprise System installer, installing Agents for Sun ONE with Minimal configuration. Also on each other node, use the pkgadd command to add the packages for these shared components: ICU, J2SE, KTSE, LDAPCSDK, NSPR, NSPRD, NSS and SASL. See Table 2-3 for information about the package names and locations for these components.

During configuration, use a location on the cluster file system as the Document Root Directory.

Web Server

Scalable

Use Sun Cluster 3.1 Data Service for Sun ONE Web Server (http://docs.sun.com/doc/817-1528) as a guide to installation and configuration.

To install the necessary packages, run the Java Enterprise System installer on each node, installing Web Server and Agents for Sun ONE with Minimal configuration. When specifying installation directories, use a location on the local file system for Web Server.

During configuration, use a location on the cluster file system as the Document Root Directory.


Note

You can deploy Identity Server and Portal Server in a highly available web container. However, they, like any web application deployed in a web container, are subject to failure such that the web container will not fail over.


Until you have fully configured the data services and all the supporting layers (volume manager, cluster file system, resource group information), Sun Cluster installation for Java Enterprise System is not complete.

Table 2-3  Shared Component Packages for High Availability Installations 

Shared Component


Packages


Location of Packages in Java Enterprise System Distribution

ICU

SUNWicu

SUNWicux

Product/shared_components/Solaris_8/Packages/ or Product/shared_components/Solaris_9/Packages/, depending on operating system version.

J2SE

SUNWj3dev

SUNWj3dmo

SUNWj3dvx

SUNWj3jmp

SUNWj3man

SUNWj3rt

SUNWj3rtx

Product/shared_components/Packages/

Note that after you add the J2SE packages, you must create the following directory and symbolic link to make them accessible to Java Enterprise System components:

# mk /usr/jdk

# ln -s /usr/j2se /usr/jdk/entsys-j2se

KTSE

SUNWktse

Product/shared_components/Packages/

LDAPCSDK

SUNWldk

SUNWldkx

Product/shared_components/Packages/

NSPR

SUNWpr

SUNWprx

Product/shared_components/Solaris_8/Packages/ or Product/shared_components/Solaris_9/Packages/, depending on operating system version.

NSPRD

SUNWprd

Product/shared_components/Solaris_8/Packages/ or Product/shared_components/Solaris_9/Packages/, depending on operating system version.

NSS

SUNWtlsu

Product/shared_components/Solaris_8/Packages/ or Product/shared_components/Solaris_9/Packages/, depending on operating system version.

SASL

SUNWsasl

SUNWsaslx

Product/shared_components/Solaris_8/Packages/ or Product/shared_components/Solaris_9/Packages/, depending on operating system version.

32-bit Directory Server on 64-bit Solaris SPARC Platform

If your Java Enterprise System deployment plan calls for running Directory Server in 32-bit mode on a Solaris SPARC platform running in 64-bit mode, you must follow this installation procedure:

  1. Use the Java Enterprise System installer to install Directory Server and Administration Server with Minimal configuration.
  2. Use the pkgrm command to remove the 64-bit Directory Server packages: SUNWdsvhx and SUNWdsvx.
  3. Edit the /var/sadm/install/productregistry file, removing references to the SUNWdsvhx and SUNWdsvx packages.
  4. Configure Directory Server as described in "To Configure Directory Server After a Minimal Installation".
  5. Configure Administrator Server as described in "To Configure Administration Server After a Minimal Installation".

Identity Server on a Non-root Owned Web Server or Application Server Instance

If your Java Enterprise System deployment plan calls for deploying Identity Server in an instance of Web Server or Application Server not owned by the superuser (root), you must install Identity Server in a separate installation session from Directory Server, Web Server and Application Server.


Note

If you have already deployed Identity Server in a root owned instance of Web Server or Application Server, then you must uninstall Identity Server (and Portal Server, if you deployed it as well) before you can continue with the following installation procedure.


The installation procedure is:

  1. Install and configure Directory Server and Administration Server. You can skip this step if Identity Server will be using a Directory Server running on a different system.
  2. Make sure that the non-root instance of Web Server or Application Server is installed and configured on the same system where you are installing Identity Server:
    • For Web Server:
    • If Web Server is not yet installed, use the Java Enterprise System installer to install Web Server with Custom configuration, specifying the non-root owner in the Runtime user and Runtime group configuration parameters.

      If Web Server is already installed, use the Web Server administrative utilities to create a new web server instance owned by the non-root user.

    • For Application Server:
    • If Application Server is not yet installed, use the Java Enterprise System installer to install Application Server.

      After Application Server is installed, use the Application Server administrative utilities to create a new application server instance owned by the non-root user.

  3. Make sure that Directory Server is running. Also make sure the non-root instance of Web Server or Application Server is running, as well as the administrative instance of Web Server or Application Server.
  4. Install Identity Server with Custom Configuration. During the installer’s configuration phase:
    • Enter the user and group information of the non-root instance owner in the System user and System group parameters when specifying Common Server Settings.
    • Enter information about the non-root instance when specifying Web Server or Application Server container parameters for Identity Server.

Portal Server on a Non-root Owned Web Server or Application Server Instance

If your Java Enterprise System deployment plan calls for deploying Portal Server in an instance of Web Server or Application Server not owned by the superuser (root), you install and configure Portal Server after deploying Identity Server in the non-root owned instance, as described in "Identity Server on a Non-root Owned Web Server or Application Server Instance." After verifying that the deployment of Identity Server operates correctly, the installation procedure for Portal Server is:

  1. Install Identity Server with Custom Configuration. During the installer’s configuration phase:
    • Enter the user and group information of the non-root instance owner in the System user and System group parameters when specifying Common Server Settings.
    • Enter information about the non-root instance when specifying Web Server or Application Server container parameters for Portal Server.
  2. After installation, change the ownership of the following directories from root to Userid:UserGroup. That is, enter:
  3. chown -R Userid:UserGroup /opt/SUNWps
    chown -R Userid:UserGroup /etc/opt/SUNWps
    chown -R Userid:UserGroup /var/opt/SUNWps

  4. Set the following permissions for the Portal Server directories:
  5. chmod 0755 /opt/SUNWps
    chmod 0755 /etc/opt/SUNWps
    chmod 0755 /var/opt/SUNWps

  6. Stop and then start Identity Server, as described in "Starting and Stopping Identity Server".

Completing Deployment of Preloaded Java Enterprise System Software

If you ordered a Sun hardware system with preloaded or preinstalled software, Java Enterprise System software might already be loaded on your system. If the following directory exists on your system, Java Enterprise System software is preloaded:

/var/spool/stage/JES_03Q4_SPARC/Solaris_sparc/

When Java Enterprise System software is preloaded, the following component products are installed in their default directories (as listed in Table 3-1) with Minimal configuration:

To complete the configuration of these preinstalled component products, refer to Chapter 8, "Postinstallation Configuration and Startup".

To install and configure the other Java Enterprise System component products, run the preloaded Java Enterprise System installer, which is located in /var/spool/stage/JES_03Q4_SPARC/Solaris_sparc/.


Determining Your Upgrade Needs

The following sections provide information to help you make decisions on how best to install your particular set of component products:

Component Product Dependencies

The following table lists the dependencies that each component product has for other component products. It does not include dependencies on shared components, such as J2SE.

Using this table, you can list or diagram the chain of dependencies that determines your eventual installation set.

Table 2-4  Cross-Component Product Dependencies 

Component Product

Required Component Product

Compatible
Version

Must Be
Local?

Sun Cluster 3.1.0

None

 

 

Administration Server and Console 5.2

Directory Server

5.2

Yes

Application Server 7.0

Message Queue

3.0.1 SP2

Yes

Calendar Server 6.0

Directory Server

5.2

No

Directory Proxy Sever 5.2

Administration Server

5.2

Yes

Directory Server 5.2

Administration Server

5.2

Yes

Identity Server 6.1

Directory Server

5.2

No

(requires a web container)

Sun ONE Application Server1

7.0

Yes

Sun ONE Web Server1

6.1.0

Yes

BEA WebLogic1,2

6.1 SP4

Yes

IBM WebSphere1,2

4.0.5

Yes

Instant Messaging 6.1

Identity Server

6.1

Yes

Messaging Server 6.0

Directory Server

5.2

No

Administration Server

5.2

Yes

Message Queue 3.0.1 SP2

None

 

 

Portal Server 6.2

Identity Server

6.1

Yes

Portal Server, Secure Remote Access 6.2

Portal Server

6.2

Yes

Identity Server

6.1

Yes

Web Server 6.1

None

 

 

1 Only one of these is required: Sun ONE Application Server, Sun ONE Web Server, BEA WebLogic, or IBM WebSphere.

2To use BEA WebLogic or IBM WebSphere, you must install both Identity Server and Portal Server.

Checking for Existing Software

The installer ensures that software that is already installed on the machine is compatible with Java Enterprise System software. If it is not, your installation is likely to be interrupted, therefore, it is a good idea to verify the versions of installed software and do any upgrading before running the installer. You can use the prodreg or pkginfo commands to examine installed software, or you can use the installer itself as described in this section.


Note

Do not rely only on the installer for this information. You must also perform an independent survey of the system to determine what software is currently installed. The installer detects only the component products that were installed by means of Solaris package distributions, and does not detect components that were originally installed by other means.


For software that has been installed by means of Solaris package distributions, you can use the installer to perform a pre-installation check of the software packages that are already on your system. In the installer, you can view the Previously Installed Products report to determine whether you need to upgrade any components.

    To Use the Graphical Installer for Identifying Component Upgrade Needs
  1. Start the installer using the -no option to indicate that this is not an active installation:
  2. ./installer -no

  3. Proceed through the installer pages to the Component Selection page.
  4. Change the drop-down list at the upper left corner to Select Components.
  5. Click View Currently Installed at the top of the page.
  6. The Previously Installed Products report lists the installed component products, specifying the level of Java Enterprise System compatibility for each component.

  7. Click Next to continue.
  8. If the machine has shared components that are incompatible with Java Enterprise System, the Shared Components Upgrades Required page is displayed.

  9. For each shared component, review the Installed Version against the Required Version to determine what upgrading needs to be done.
  10. Exit the installer and do one or both of the following:
    • For component products—Follow the instructions in Chapter 4, "Upgrading System Components" to upgrade component products.
    • For shared components—Determine whether the newer Java Enterprise System version is compatible with other installed applications on the host.

    • Caution

      Do not upgrade shared components without checking the dependencies that exist on the host. Functional problems might occur for applications installed on the host that use the shared components. You should verify that existing applications are compatible with the required versions of the shared components.


      After you have verified that it is safe to upgrade shared components on the host, do one of the following:

      • Remove or upgrade shared components as needed.
      • Or

      • Allow the installer to upgrade shared components during your active installation.

      • Note

        After upgrading, the machine must be rebooted for new versions to be recognized.


  11. Repeat the process until the installer indicates that components meet Java Enterprise System requirements.

For instructions on using the text-based installer, refer to "To Use the Text-Based Installer for Identifying Upgrade Needs".


Verifying System Readiness

Before you start the installation process, consider the following:

Access Privileges

To install Java Enterprise System software, you must be logged in as root, or become superuser.

System Requirements

Before you install Java Enterprise System, ensure that you have met the minimum hardware and operating system requirements. For the latest information on the supported platforms and software and hardware requirements, see the Java Enterprise System Release Notes (http://docs.sun.com/doc/816-6876).

If the operating system found on the machine does not satisfy Java Enterprise System recommendations, the installer cannot proceed. You will need to exit the installer, resolve the problem, and restart the installer.

Memory and Disk Space Requirements

The installer runs a check to determine if your machine has sufficient memory and disk space for the component products you selected.


Choosing an Installation Mode

The Java Enterprise System installer offers two interactive installation modes (graphical and text-based) and one non-interactive mode (silent).

When to Choose Graphical Mode

The installer’s graphical mode provides a wizard that leads you, step by step, through the tasks that you need to perform to install Java Enterprise System components.

Consider using graphical mode under any of these circumstances:

When to Choose Text-Based Mode

The installer’s text-based mode provides the same functions that the graphical interface provides. However, this mode prompts you for responses on a line-by-line basis, rather than by means of a wizard.

Consider using text-based mode if you install from a terminal window and want to install interactively.

When to Choose Silent Mode

Silent mode enables you to save the values required for installation in a reusable script called a state file. A state file contains a set of name-value pairs that represent installation and configuration parameters. You then run the installer on multiple systems, each time using the state file to specify options.

Consider using silent mode under these circumstances:


Choosing a Configuration Type

The Java Enterprise System installer offers two types of configuration:

The following table lists the configuration options available for each component product.

Table 2-5  Configuration Types for Component Products 

Component Product

Custom Configuration

Minimal Configuration

Administration Server

Yes

Yes

Application Server

Yes

Yes

Calendar Server

No

Yes

Directory Server

Yes

Yes

Directory Proxy Server

Yes

Yes

Identity Server

Yes

No

Instant Messaging

No

Yes

Message Queue

Yes

Yes

Messaging Server

No

Yes

Portal Server

Yes

Yes

Sun Cluster

No

Yes

Web Server

Yes

Yes

When to Choose Custom Configuration

Custom configuration lets you specify configuration values for component products during installation.

Custom configuration is useful under the following circumstances:

Refer to Table 2-5 for a list of component products that support custom configuration.

When to Choose Minimal Configuration

Minimal configuration requires the least effort at installation time but requires post-installation configuration. When you select the minimal configuration option during installation, the Java Enterprise System installer places the component product package files in their respective directories. No parameter setting is done, and most component products are not operational because runtime services are not available.


Note

If you choose a minimal configuration installation and select Identity Server as a component, the installer requires you to perform configuration for Identity Server and any associated components during installation.



Gathering Configuration Data

If you plan to select custom configuration, or to select minimal configuration including Identity Server, you will be asked to provide the configuration information for your component products during installation.


Note

Exceptions are the Calendar Server, Instant Messaging, Messaging Server, or Sun Cluster components, which cannot be configured during installation.


Information on configuration parameters for the component products is contained in Chapter 3, "Gathering Installation and Configuration Information". For your convenience, worksheets for recording your configuration data are provided in Appendix A, "Worksheets for Gathering Information".

At the end of the installation process, a summary file contains the configuration values set during installation. You can view this file from the installer, or from the directory where it is saved, /var/sadm/install/logs.

Installation Directories

You need to decide where you will install the software for the various component products. If you will be using the default directories supplied by the installer, no preinstallation action is necessary. Default directory information is contained in "Installation Directories".

Port Assignments

You need to plan port number assignments for the component products you are installing. If you will be using the default port numbers supplied by the installer, no preinstallation action is necessary. Default port number information is contained in Appendix C, "Component Port Numbers".


Next Steps

After you have completed the tasks in this chapter, including gathering configuration information or upgrading, you can proceed to one of the following installation chapters:



Previous      Contents      Index      Next     


Copyright 2003 Sun Microsystems, Inc. All rights reserved.