Sun Java Enterprise System 2005Q4 Upgrade Guide |
Chapter 16
Instant MessagingThis chapter describes how to upgrade Instant Messaging to Java ES 2005Q4 (Release 4): Sun Java System Instant Messaging 7.0.1 2005Q4. The chapter provides a general overview of upgrade issues and procedures for the different upgrade paths supported by Java ES Release 4. The chapter covers upgrades on both the Solaris and Linux operating systems:
Overview of Instant Messaging UpgradesThis section describes the following general aspects of Instant Messaging that impact upgrading to Java ES 2005Q4 (Release 4):
About Java ES Release 4 Instant Messaging
Java ES Release 4 Instant Messaging mostly represents bug fixes. There is no major new functionality with respect to Release 3.
Instant Messaging Upgrade Roadmap
Table 16-1 shows the supported Instant Messaging upgrade paths to Java ES Release 4. The table applies to both Solaris and Linux operating systems.
Instant Messaging Data
The following table shows the type of data that could be impacted by an upgrade of Instant Messaging software.
Compatibility Issues
Release 4 Instant Messaging does not introduce any interface changes and is backwardly compatible with earlier versions.
Instant Messaging Dependencies
Instant Messaging dependencies on other Java ES components can impact the procedure for upgrading and re-configuring Instant Messaging software. Changes in Instant Messaging interfaces or functions, for example, could require upgraded version of components upon which Instant Messaging depends. The need to upgrade such components depends upon the specific upgrade path.
Instant Messaging has dependencies on the following Java ES components:
- Shared components. Instant Messaging has dependencies on specific Java ES shared components (see Table 1-6).
- Web Container. Instant Messaging depends upon web container services, which can be provided either by Java ES Web Server or Java ES Application Server.
- Directory Server (optional). Instant Messaging can be configured to store and access user data in Directory Server. As a result, Instant Messaging upgrades might require extensions of directory schema.
- Access Manager (optional). For software solutions that support single user sign-on for web-based services, Instant Messaging can be configured to use Access Manager single sign-on capability.
Upgrading Instant Messaging from Java ES Release 3This section includes the following information about upgrading Instant Messaging from Java ES Release 3 to Java ES Release 4. The section covers the following topics:
Introduction
When upgrading Java ES Release 3 Instant Messaging to Release 4, consider the following aspects of the upgrade process:
- General Upgrade Approach. The upgrade is performed by applying patches to the Release 3 version. There is no re-configuration of Instant Messaging required.
- Upgrade Dependencies. While Instant Messaging has dependencies on a number of Java ES shared components (see Table 1-6), Release 4 Instant Messaging requires only that IM-SDK be upgraded to Release 4. Upgrade of other shared components is optional with respect to upgrade of Instant Messaging to Release 4.
In addition, Release 4 Instant Messaging is dependent on a web container and optionally dependent on Access Manager, as described in Instant Messaging Dependencies. However, these are soft upgrade dependencies; upgrade the web container and Access Manager is optional with respect to upgrade of Instant Messaging to Release 4.
- Backward Compatibility. Release 4 Instant Messaging is backwardly compatible with the Release 3 version.
- Upgrade Rollback. Rollback of the Release 4 upgrade to Release 3 is achieved on Solaris platforms by removing the patches applied during the upgrade.
- Platform Issues. The general approach for upgrading Instant Messaging is the same on both Solaris and Linux operating systems, however the patching technologies are different. The upgrade process therefore includes platform-specific procedures.
Release 3 Instant Messaging Upgrade
This section describes how to perform an upgrade of Instant Messaging from Java ES Release 3 to Java ES Release 4 on both the Solaris and Linux platform. Where a topic depends on platform-specific procedures, the topic will indicate the operating system to which it applies. The section covers the following topics:
Pre-Upgrade Tasks
Before you upgrade Instant Messaging you should perform the tasks described below.
Verify Current Version Information
You can verify the current version of Instant Messaging using standard version checking utilities
Upgrade Instant Messaging Dependencies
It is generally recommended that all Java ES components on a computer system (and in a computing environment) be upgraded to Java ES Release 4. However, Instant Messaging has a hard upgrade dependency only on the IM-SDK shared component. Upgrading of otherJava ES Release 3 components upon which Instant Messaging depends is therefore optional.
If you choose to upgrade all Instant Messaging dependencies, they should be upgraded in the following order, all before you upgrade Instant Messaging. You can skip any that might already have been upgraded.
- Shared Components. Instructions for upgrading IM-SDK and other Java ES shared components to Release 4 are provided in Chapter 2, "Upgrading Java ES Shared Components".
- Web Container Software. Instructions for upgrading Web Server or Application Server are provided in Chapter 6, "Web Server" and Chapter 9, "Application Server", respectively.
- Access Manager (optional). Instructions for upgrading Access Manager to Release 4 are provided in Chapter 11, "Access Manager".
Back Up Instant Messaging Data
The Instant Messaging upgrade from Release 3 to Release 4 does not modify configuration data. However, as a safety measure it is a good idea to back up the Instant Messaging database and any existing resource and configuration files you have customized before upgrading Instant Messaging. For more information, see the Sun Java System Instant Messaging 7 2005Q4 Administration Guide (http://docs.sun.com/doc/819-2503).
Obtain Required Configuration Information and Passwords
You have to log in as superuser to perform the upgrade. If you are using Web Server as a web container, no configuration information is needed. However if you are using Application Server as a web container, you will need the Application Server administrator user ID and password.
Upgrading Release 3 Instant Messaging (Solaris)
This section discusses considerations that impact the upgrade procedure for Instant Messaging followed by a description of the procedure itself.
Upgrade Considerations (Solaris)
The upgrade of Instant Messaging software to Java ES Release 4 takes into account the following considerations:
- Instant Messaging components should be shut down when patches are being applied to the installed image.
- In architectures in which different Instant Messaging subcomponents reside on different computers, for example messenger resources on one computer, Instant Messaging server on another, and Instant Messaging Multiplexor on yet another, the upgrade must be performed on all such computers.
- The Instant Messaging upgrade applies to multiple subcomponents of Instant Messaging on one computer using the same installed image.
- The Release 4 Instant Messaging upgrade patch for Solaris OS are shown in the following table:
Table 16-4 Patches1 to Upgrade Instant Messaging on Solaris
Description
SPARC
Solaris 8, 9, & 10
X86
Solaris 9 & 10
Instant Messaging
118786-08
118787-08
Instant Messaging localization
119707-06
119707-06
1Patch revision numbers are the minimum required for upgrade to Java ES Release 4. If newer revisions become available, use the newer ones instead of those shown in the table.
Upgrade Procedure (Solaris)
The procedure documented below applies to Instant Messaging on the computer where the upgrade is taking place.
- Obtain the required patches, based on Table 16-4.
Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access
- Log in as root or become superuser.
su -
- Stop Instant Messaging if it is running.
InstantMessaging-base/sbin/imadmin stop
- If you have not already done so, upgrade the IM-SDK shared component to Release 4 and any other shared components you wish to upgrade.
See Upgrade Instant Messaging Dependencies.
- Apply the appropriate Instant Messaging patches in Table 16-4.
Be sure to apply the Instant Messaging localization patch (119707) before applying the Instant Messaging base patch.
patchadd patch_ID
- Confirm that the upgrade was successful:
showrev -p | grep patch_ID
The output should return the versions of patch IDs applied in Step 5.
- Restart the Instant Messaging service that was stopped in Step 3.
InstantMessaging-base/sbin/imadmin start
Upgrading Release 3 Instant Messaging (Linux)
This section discusses considerations that impact the upgrade procedure for Instant Messaging followed by a description of the procedure itself.
Upgrade Considerations (Linux)
The upgrade of Instant Messaging software to Java ES Release 4 on the Linux platform takes into account the same considerations as on the Solaris platform (see Upgrade Considerations (Solaris)), except that the Linux Release 4 upgrade patches differ from the Solaris patches.
The Release 4 Instant Messaging upgrade patch for Linux OS is shown in the following table:
Table 16-5 Patches1 to Upgrade Instant Messaging on Linux
Description
Patch ID and RPM names
Instant Messaging
118788-11
Instant Messaging localization
119708-06
1Patch revision numbers are the minimum required for upgrade to Java ES Release 4. If newer revisions become available, use the newer ones instead of those shown in the table.
Upgrade Procedure (Linux)
The procedure documented below applies to Instant Messaging on the computer where the upgrade is taking place.
- Obtain the required patch using the patch number and RPM name from Table 16-5. Use this information to obtain the version numbers for the RPM.
Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access
- Log in as root or become superuser.
su -
- Stop Instant Messaging if it is running.
InstantMessaging-base/sbin/imadmin stop
- If you have not already done so, upgrade the IM-SDK shared component to Release 4 and any other shared components you wish to upgrade.
See Upgrade Instant Messaging Dependencies.
- Apply the RPMs for Instant Messaging in Table 16-5.
Be sure to apply the Instant Messaging localization patch (119708) before applying the Instant Messaging base patch.
rpm -Fvh sun-im-module-Locale-7.0-2.8.i386.rpm
rpm -Fvh sun-im-module-7.0-13.8.i386.rpm- Confirm that the upgrade was successful:
rpm -qa | grep sun-im
The new version numbers of the RPMs should be returned.
- Restart the Instant Messaging service that was stopped in Step 3.
InstantMessaging-base/sbin/imadmin start
Verifying the Upgrade
The upgrade of Instant Messaging to Release 4 is verified by confirming that the upgrade patches have been properly applied. The steps for this verification were included in Upgrade Procedure (Solaris) and Upgrade Procedure (Linux).
You can also check the status of the various Instant Messaging subcomponents using the following command:
Or you can check the log file located at iim.instancevardir/log,
where instancevardir is specified in the iim.conf file (for path, see Table 16-2).
Post-Upgrade Tasks
There are no post-upgrade tasks beyond the steps described in Upgrade Procedure (Solaris) and Upgrade Procedure (Linux).
Rolling Back the Upgrade (Solaris)
This section describes considerations that impact the upgrade rollback procedure for Instant Messaging followed by the procedure itself.
Rollback Considerations (Solaris)
The procedure for rolling back the upgrade to Release 4 of Instant Messaging is pretty much the reverse of the procedure for upgrading to Release 4.
Rollback Procedure (Solaris)
- Log in as root or become superuser.
su -
- Stop Instant Messaging if it is running.
InstantMessaging-base/sbin/imadmin stop
- Remove the patches in Table 16-4.
patchrm patch_ID
- Restart the Instant Messaging service that was stopped in Step 2.
InstantMessaging-base/sbin/imadmin start
Multiple Instance Upgrades
Multiple instance upgrades are not applicable to Release 4 Instant Messaging.
Upgrading Instant Messaging from Java ES Release 2This section includes information about upgrading Instant Messaging from Java ES 2004Q2 (Release 2) to Java ES 2005Q4 (Release 4). The procedure for upgrading Release 2 Instant Messaging to Release 4 is quite different from that for upgrading from Release 3 Instant Messaging.
The section covers the following topics:
Introduction
When upgrading Java ES Release 2 Instant Messaging to Release 4, consider the following aspects of the upgrade process:
- General Upgrade Approach. The upgrade is performed using an upgrade utility that performs all operations needed to upgrade Instant Messaging software.
- Upgrade Dependencies. Upgrade of any Java ES component on a computer from Release 2 requires the upgrade of all other Java ES components hosted by the computer; selective upgrade of Java ES components from Release 2 to Release 4 is not supported. In particular, all Java ES shared components used by Instant Messaging, the web container, and Access Manager need to be upgraded to Release 4.
- Backward Compatibility. Release 4 Instant Messaging is backwardly compatible with the Release 2 version.
- Upgrade Rollback. Rollback of the Release 4 upgrade to Release 2 is achieved by saving all Release 2 software and data and manually reverting back to the Release 2 version. There is no utility for rolling back the upgrade.
- Platform Issues. The general approach for upgrading Instant Messaging is the same on both Solaris and Linux operating systems. The upgrade process includes any platform-specific details.
Release 2 Instant Messaging Upgrade
This section describes how to perform an upgrade of Instant Messaging from Java ES Release 2 to Java ES Release 4 on both the Solaris and Linux platform. Where a topic depends on platform-specific procedures, the topic will indicate the operating system to which it applies. The section covers the following topics:
Pre-Upgrade Tasks
Before you upgrade Instant Messaging you should perform the tasks described below.
Verify Current Version Information
You can verify the current version of Instant Messaging using standard version checking utilities
See Table 16-3 for output values.
Upgrade Instant Messaging Dependencies
Java ES Release 4 does not support the coexistence of Release 2 and Release 4 shared components on a single computer.
You are therefore required to upgrade all local Java ES Release 2 components on which Instant Messaging depends to Release 4. When you upgrade all Instant Messaging dependencies on a computer, they should be upgraded in the following order, all before you upgrade Instant Messaging.
- Shared Components. All shared components upon which Instant Messaging depends must be upgraded to Release 4. If other Java ES product components coexist with Instant Messaging on a single computer, you have to upgrade all Java ES shared components residing on that computer. Instructions for upgrading Java ES shared components to Release 4 are provided in Chapter 2, "Upgrading Java ES Shared Components").
- Web Container Software. Instructions for upgrading Web Server or Application Server are provided in Upgrading Web Server from Java ES Release 2 and Upgrading Application Server from Java ES Release 2, respectively.
- Access Manager (Access Manager SDK). Instructions for upgrading Access Manager to Release 4 are provided in Upgrading Access Manager from Java ES Release 2.
- Directory Server. Instant Messaging is rarely dependent on a local Directory Server, however, instructions for upgrading Directory Server to Release 4 are provided in Upgrading Directory Server and Administration Server from Java ES Release 2
Back Up Instant Messaging Data
The Instant Messaging upgrade from Release 2 to Release 4 modifies configuration data and customizations. Before upgrading Instant Messaging, it is a good idea to back up the Instant Messaging database and any existing resource and configuration files. For more information, see the Sun Java System Instant Messaging 7 2005Q4 Administration Guide (http://docs.sun.com/doc/819-2503).
Obtain Required Configuration Information and Passwords
You have to log in as superuser to perform the upgrade. If you are using Web Server as a web container, no configuration information is needed. However if you are using Application Server as a web container, you will need the Application Server administrator user ID and password.
Upgrading Release 2 Instant Messaging (Solaris)
This section discusses considerations that impact the upgrade procedure for Instant Messaging followed by a description of the procedure itself.
Upgrade Considerations (Solaris)
The upgrade of Instant Messaging software to Java ES Release 4 takes into account the following considerations:
- In architectures in which different Instant Messaging subcomponents reside on different computers, for example messenger resources on one computer, Instant Messaging server on another, and Instant Messaging Multiplexor on yet another, the upgrade must be performed on all such computers. However, the upgrade applies to multiple subcomponents of Instant Messaging on one computer using the same installed image.
- The upgrade of Release 2 Instant Messaging software to Java ES Release 4 makes use of an upgrade utility that performs the following operations:
- Creates a temporary directory where it stores working files.
- Gathers and temporarily stores previous package installation parameters for all packages installed on the system.
- Shuts down the previous version of the Instant Messaging server.
- Installs new packages and patches existing packages.
- Installs any new shared component packages needed by Instant Messaging.
- Saves the previous graphics contents from IIM_DOCROOT and restores them to the new resource files location.
- Restarts all services.
- Deletes the temporary directory and its contents.
Upgrade Procedure (Solaris)
The procedure documented below applies to Instant Messaging on the computer where the upgrade is taking place.
- Log in as root or become superuser.
su -
- If you have not already done so, upgrade the IM-SDK shared component to Release 4 and any other shared components you wish to upgrade.
See Upgrade Instant Messaging Dependencies.
- Run the upgrade utility from the Instant Messaging tools directory of the Java ES distribution.
cd /Solaris_arch/Product/instant_messaging/Tools
./upgradeThe upgrade utility creates a log file that shows the progression of the upgrade process. The log file resides in the following location:
/var/sadm/install/logs/Instant_Messaging_Upgrade.timestamp
Where timestamp is in the format yyyymmddhhss.
- (Optional) Change configuration as necessary to use new features introduced after Release 2. For configuration information, see Sun Java System Instant Messaging Administration Guide, http://docs.sun.com/doc/819-0430.
- Re-customize messenger resources.
If you had customized your messenger resources, you need to reapply those customizations to the following files:
InstantMessaging-base/html/Locale/imbrand.jar
InstantMessaging-base/html/Locale/imb[ssl].html|jnlpConsult the customized files that you saved under Back Up Instant Messaging Data.
- Re-deploy messenger resources into the web container.
InstantMessaging-base/lib/deployHtml -f webcontainerDeployLocation
where webcontainerDeployLocation is the directory location where you want to deploy the messenger resources. The location generally depends on the web container being used, for example:
Web Server
WebServer-base/docs/imApplication Server
AppServer8Config-base/nodeagents/hostName_domainName/instanceName/
docroot/iimUpgrading Release 2 Instant Messaging (Linux)
This section discusses considerations that impact the upgrade procedure for Instant Messaging followed by a description of the procedure itself.
Upgrade Considerations (Linux)
The upgrade of Instant Messaging software to Java ES Release 4 on the Linux platform takes into account the same considerations as on the Solaris platform (see Upgrade Considerations (Solaris)).
Upgrade Procedure (Linux)
The procedure documented below applies to Instant Messaging on the computer where the upgrade is taking place.
- Log in as root or become superuser.
su -
- If you have not already done so, upgrade the IM-SDK shared component to Release 4 and any other shared components you wish to upgrade.
See Upgrade Instant Messaging Dependencies.
- Run the upgrade utility from the Instant Messaging tools directory of the Java ES distribution.
cd /Linux_x86/Product/instant_messaging/Tools
./upgradeThe upgrade utility creates a log file that shows the progression of the upgrade process. The log file resides in the following location:
/var/sadm/install/logs/Instant_Messaging_Upgrade.timestamp
Where timestamp is in the format yyyymmddhhss.
- (Optional) Change configuration as necessary to use new features introduced after Release 2. For configuration information, see Sun Java System Instant Messaging Administration Guide, http://docs.sun.com/doc/819-0430.
- Re-customize messenger resources.
If you had customized your messenger resources, you need to reapply those customizations to the following files:
InstantMessaging-base/html/Locale/imbrand.jar
InstantMessaging-base/html/Locale/imb[ssl].html|jnlp
Consult the customized files that you saved under Back Up Instant Messaging Data.
- Re-deploy messenger resources into the web container.
InstantMessaging-base/lib/deployHtml -f webcontainerDeployLocation
where webcontainerDeployLocation is the directory location where you want to deploy the messenger resources. The location generally depends on the web container being used, for example:
Web Server
WebServer-base/docs/imApplication Server
AppServer8Config-base/nodeagents/hostName_domainName/instanceName/
docroot/iimVerifying the Upgrade
You can check the status of the various Instant Messaging subcomponents using the following command:
Or you can check the log file located at iim.instancevardir/log,
Post-Upgrade Tasks
There are no post-upgrade tasks beyond the steps described in Upgrade Procedure (Solaris) and Upgrade Procedure (Linux). However, if you wish to use the feature enhancements of Release 4 over those of Release 2, you need to re-configure Instant Messaging and redeploy to the web container.
Rolling Back the Upgrade
Rollback of the Release 4 upgrade to Release 2 is achieved by saving all Release 2 software and data (see Back Up Instant Messaging Data) and manually reverting back to the Release 2 version. There is no utility for rolling back the upgrade.
Multiple Instance Upgrades
Multiple instance upgrades are not applicable to Release 4 Instant Messaging.