Sun Java Enterprise System 5 Update 1 Upgrade Guide for Microsoft Windows

Chapter 3 Directory Server

This chapter describes how to upgrade Directory Server from Java ES 5 (Release 5) to Java ES 5 Update 1 (Release 5U1): Sun Java System Directory Server 6.2.

The chapter provides an overview of upgrade issues and procedures for the upgrade path supported by Release 5U1. This chapter covers the following topics:

Note –

File locations in this chapter are specified with respect to a directory path referred to as DSEE-base. At least part of this path might have been specified as an installation directory when Directory Server was initially installed. If not, the Java ES installer assigns a default value.

The default value of DSEE-base is C:\Program Files\Sun\JavaES5\DSEE.

The default value of instancePath is C:\Program Files\Sun\JavaES5\DSEE\var\DSInstance

About Directory Server Enterprise Edition

Directory Server, Directory Proxy Server, and Directory Services Control Center (DSCC) are three components of Directory Server Enterprise Edition (DSEE). The three components can be installed together on the same system or separately on different systems.

In a deployment scenario in which Directory Server, Directory Proxy Server and Directory Server Control Center are installed on the same system, you cannot upgrade any one component without upgrading the other two. When you apply the DSEE patch to upgrade any of the components, all three are automatically upgraded.

In a deployment scenario in which the three components are installed separately on different systems, you must apply the patch individually on each of the systems to upgrade the components.

On the system running DSCC, DSCC is using a specific Directory Server instance also named DSCC Registry. This instance of Directory Server stores the DSCC configuration data. When upgrading DSCC you must stop this instance. The command to identify the instance is:

DSEE-base\dscc6\bin\dsccsetup.exe status

The output will contain the path of the DSCC Registry. During the upgrade procedure described in this chapter, when you are asked to stop the running instances, you must stop the DSCC registry too.

Execute the command DSEE-base\dscc6\bin\dsccsetup.exe stop instancePath to stop the instance.

Overview of Directory Server Upgrade

This section describes the following general aspects of Directory Server that affect upgrading to Java ES 5 Update 1 :

About Release 5U1

Release 5U1 Directory Server is a maintenance release that fixes bugs in Release 5 Directory Server. For more information, see the Sun Java System Directory Server Enterprise Edition 6.2 Release Notes.

Java ES Release 5U1 Upgrade Roadmap

The following table shows the supported Directory Server upgrade paths to Release 5U1:

Table 3–1 Upgrade Paths to Java ES 5 Update 1: Directory Server 6.2


Java ES Release	Directory Server Release	General Approach	Reconfiguration Required as Part of Upgrade
Release 5	Sun Java System Directory Server 6.0	Maintenance upgrade. Apply patches.	None
Release 4		Direct upgrade of Directory Server from Release 4 to Release 5U1 is not supported. This upgrade path is supported by first upgrading Release 4 Directory Server to Release 5 Directory Server and then upgrading Release 5 to Release 5U1. The information about upgrading Release 4 to Release 5 is documented in Sun Java ES 5 Upgrade Guide for Microsoft Windows.

Directory Server Data

Directory Server 6.x configuration is performed using the Directory Service Control Center or the Directory Server Enterprise Edition command-line utilities.

The following table shows the type of data that can be impacted by an upgrade of Directory Server software to Release 5U1.

Table 3–2 Directory Server Data Usage


Type of Data	Location	Usage
Directory Server configuration data	Directory Server 6.x: accessed through Directory Service Control Center and Directory Server EE command-line utilities	Configuration of Directory Server
Directory Server schema		Define structure and semantics of data in the directory
Security data	Directory Server 6.x: SSL configured through Directory Service Control Center and Directory Server Enterprise Edition command-line utilities	Server certificates
User data	Directory Server	Server certificates

Directory Server Compatibility Issues

Release 5U1 Directory Server does not introduce any interface changes and is therefore backwardly compatible with Release 5 Directory Server.

Directory Server Dependencies

Dependencies on other Java ES components can, in general, impact the procedure for upgrading Directory Server software. Directory Server has dependencies on the following Java ES components:

Shared Components. Directory Server has dependencies on specific Java ES shared components (see Table 1–8. Directory Server upgrades might depend upon upgraded versions of these shared components.
Directory Proxy Server. Directory Server has a co-dependency on Directory Proxy Server for providing improved security and performance for LDAP requests.

Upgrading Directory Server from Java ES Release 5

This section includes information about upgrading Directory Server from Java ES 5 to Java ES 5 Update 1 . The section covers the following topics:

Introduction

When upgrading Release 5 Directory Server to Release 5U1, consider the following aspects of the upgrade process:

General Upgrade Approach. The upgrade is achieved by patching Release 5 Directory Server.
Upgrade Dependencies. Directory Server has dependencies on a number of Java ES shared components, (see Table 1–8), of which CAC, MFWK, SJWC, and Security components (NSS,JSS,NSPR) need to be upgraded when you perform a maintenance upgrade of Directory Server.
Backward Compatibility. Release 5U1 Directory Server is backwardly compatible with the Release 5 version.
Upgrade Rollback. You can do a rollback of the Release 5 upgrade by reverting to the previous version, which is left intact by the upgrade.

Release 5 Directory Server Upgrade

This section describes how to perform an upgrade of Directory Server from Java ES 5 to Java ES 5 Update 1. The section covers the following topics:

Pre-Upgrade Tasks

Before you upgrade Directory Server, perform the following tasks.

Verify Current Version Information

Verify the current version of Directory Server before you upgrade.

To Verify Current Version Information

Check the current version of Directory Server instance.

DSEE-base\ds6\bin\dsadm.exe -V
[dsadm] dsadm : 6.0 [Build information]

Upgrade Directory Server Dependencies

It is generally recommended that all Java ES components on a computer system (and in a computing environment) be upgraded to Release 5U1. Before upgrading Directory Server, you need to upgrade CAC, MFWK, SJWC, and Security components (NSS,JSS,NSPR). Also, Directory Server requires that Windows Installer patch (126910–02) is already applied.

Upgrading Release 5 Directory Server

This section discusses considerations that impact the upgrade procedure for Directory Server, followed by a description of the procedure itself.

Upgrade Considerations

This upgrade of Directory Server software to Release 5U1 takes into account the following considerations:

Any Java ES components or applications using a Directory Server instance should be shut down if performing LDAP queries during the Directory Server upgrade or if using a library that is being patched.
In a deployment architecture in which there are multiple instances of Directory Server running on a single computer (all corresponding to the same installed Directory Server image), you only have to upgrade the Directory Server image once.
In a maintenance upgrade, you do not have to migrate schema, configuration, security and user data.
The Release 5U1 Directory Server upgrade patches for Windows OS are shown in the following table:

Table 3–3 Patches to Upgrade Directory Server on Windows


Description	Patch ID [Patch revision numbers are the minimum required for upgrade to Release 5U1. If newer revisions become available, use the newer ones instead of those shown in the table.]
Directory Server Enterprise Edition core (includes Directory Server)	125311–05
Directory Server localization	The localized patch files are delivered within the core patch.

Upgrade Procedure

The procedure documented below applies to Directory Server instances residing locally on the computer where the upgrade is taking place.

To Upgrade Directory Server to Release 5U1

Stop any Java ES components which use the Directory Server.

Stop the service using persistent connections like Access Manager. You can stop Access Manager by stopping its web container.

Shut down the Directory Server.

Also shut down Directory Proxy Server and Directory Registry if they are on the same system.

DSEE-base\ds6\bin\dsadm.exe stop instancePath

DSEE-base\dps6\bin\dpadm.exe stop instancePath

DSEE-base\dscc6\bin\dsccsetup.exe stop instancePath

Make sure you have upgraded any Java ES components upon which Directory Server has hard upgrade dependencies (see Upgrade Directory Server Dependencies.

Obtain the required Directory Server Release 5U1 upgrade patches, based on Table 3–3.

To obtain the patch, see Accessing Java ES Patches. Patches can be downloaded to \workingDirectory.

Install the patch.

Installation is generally performed by running patch-id.exe, however, be sure to consult the README.patch-id file in the patch directory for installation instructions.

Note –
If you are prompted to restart the system, select No. Wait till the patch installation process is completed and then restart and re-login as the same user to complete the patch installation.

Verify the patch log file.

The log file is found at: %TEMP%\SUNJAVAES_<patch-id>.log

Verify the patch installation with the utility ListJavaESPatches.exe.

Run ListJavaESPatches.exe and check that the output includes the patch id of the patch that you have installed in Step 6. For more information, see Identifying Installed Java ES Patches.

Refresh DSCC application into SJWC.

Note –
This step should be performed on the system where DSCC is installed.

DSEE-base\dscc\bin\dsccsetup console-unreg

DSEE-base\dscc\bin\dsccsetup console-reg

Start the Directory Server.

Also start Directory Proxy Server and Directory Registry if they are on the same system.

DSEE-base\ds6\bin\dsadm.exe start instancePath

DSEE-base\dps6\bin\dpadm.exe start instancePath

DSEE-base\dscc6\bin\dsccsetup.exe start instancePath

Restart CAC.

Start any Java ES components that use Directory Server.

Verifying the Upgrade

You can verify successful upgrade of Directory Server as follows:

Log in as administrator.
Check the new Directory Server instance.DSEE-base\ds6\bin\dsadm.exe -V
[dsadm] dsadm : 6.2 [Build information]

Post-Upgrade Tasks

There are no post-upgrade tasks beyond the steps described in Upgrade Procedure.

Rolling Back the Upgrade

Log in as administrator.
Shut down the Directory Server instances.

DSEE-base\ds6\bin\dsadm stop instancePath
Double-click Uninstall_patch-id.bat to uninstall the patch.
Restart the Directory Server instances that were shut down in step 2.DSEE-base\ds6\bin\dsadm.exe start instancePath
Check the version of the Directory Server instance.

DSEE-base\ds6\bin\dsadm.exe -V
[dsadm] dsadm : 6.0 [Build information]