Chapter 3 Sun Java System Instant Messaging 7 2005Q4 Release Notes

Version 7 2005Q4

These Release Notes contain important information available at the time of release of Sun Java^TM System Instant Messaging 7 2005Q4. New features and enhancements, known issues and limitations, and other information are addressed here. Read this document before you begin using Instant Messaging 7 2005Q4.

To ensure the best deployment with Instant Messaging, you should download the latest patches for this version of the product from SunSolve Online.

The most up-to-date version of these release notes can be found at the Sun Java System documentation web site. Check the web site prior to installing and setting up your software and then periodically thereafter to view the most up-to-date release notes and product documentation. These release notes contain the following sections:

• Release Notes Revision History

• About Instant Messaging 7 2005Q4

• What’s New in This Release

• Requirements

• Installation Notes

• Compatibility Issues

• Documentation Updates

• Problems Fixed in This Release

• Known Issues and Limitations

• Configuring Instant Messaging for High Availability (Solaris Only)

• Redistributable Files

Third-party URLs are referenced in this document and provide additional, related information.

Sun is not responsible for the availability of third-party Web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused by or in connection with the use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

Release Notes Revision History

About Instant Messaging 7 2005Q4

Sun Java System Instant Messaging delivers secure presence and extended real-time messaging, enabling communities of users to communicate and collaborate instantly and securely. It combines instant messaging capabilities with conferences, alerts, news, polling, and file transfer to create a rich collaborative environment. It leverages an existing community, managed using LDAP, Sun Java System Access Manager, or Sun Java System Portal Server.

What’s New in This Release

This section includes the following topics:

• Installation

• New Features

Installation

The Instant Messaging Installation Guide has been discontinued. If you are installing Instant Messaging 7 2005Q4 for the first time, see the Sun Java Enterprise System Installation Guide for installation instructions. If you are upgrading from a previous version of Instant Messaging, see the Sun Java Enterprise System Upgrade Guide.

If you are using Access Manager with Instant Messaging you need to install the “Legacy (version 6.x style)” Access Manager using the Java Enterprise System installer. This version of Instant Messaging is not compatible with the “Realm (version 7.x style)” Access Manager.

New Features

This section describes the following new feature added to Instant Messaging in this release:

Failover Support Using Sun^TM Cluster (Solaris Only)

This release of Instant Messaging provides failover support for Solaris, using Sun Cluster. This increases Instant Messaging's availability and providing monitoring of and recovery from software and hardware failures.

See Configuring Instant Messaging for High Availability (Solaris Only) for more information about this feature.

Requirements

This section lists the requirements for installing Instant Messaging software. Before you install, ensure you have met the minimum hardware and operating system requirements. JRE 1.4 is supported by both server and client. In addition, check for any product patches before you install.

For the current list of required patches for Sun Java System Instant Messaging, go to SunSolve Online and select either “Patches” or “Patch Portal”. Follow the Sun Java System Instant Messaging links. As system patch requirements change and patches to Java Enterprise System components become available, updates will be made available on SunSolve, initially in the form of recommended patch clusters.

The hardware and software requirements for this release of Instant Messaging software are described in the following sections:

• Server Operating System Requirements

• Server Software Requirements

• Server Hardware Requirements

• Client Operating System Requirements

• Client Software Requirements

• Client Hardware Requirements

Server Operating System Requirements

This release of Sun Java System Instant Messaging supports the following platforms:

• Solaris^TM 8 (5.8) Operating System (Solaris OS) (SPARC® Platform Edition)

• Solaris 9 (5.9) OS (SPARC Platform Edition, x86 Platform Edition, and Opteron Platform Edition)

• Solaris 10 OS (SPARC Platform Edition, x86 Platform Edition, Opteron Platform Edition)

• Red Hat Enterprise Linux AS 2.1 and AS 3.0.

A list of recommended patches for Solaris can be found at SunSolve Online.

Server Software Requirements

This version of Instant Messaging is compatible with the following versions of other server software:

• Sun Java System Access Manager 7 2005Q4

• Sun Java System Application Server Enterprise Edition 8 2005Q4

• Sun Java System Calendar Server 6 2005Q4

• Sun Java System Directory Server 5 2005Q4

• Sun Java System Messaging Server 6 2005Q4

• Sun Java System Portal Server 6 2005Q4

• Sun Java System Web Server 6.1 2005Q4 SP5

Server Hardware Requirements

The minimum hardware requirements for installing Instant Messaging are as follows:

• Approximately 300 MB of free disk space for the software.

• Approximately 5K of disk space for each user.

• At least 256 MB of RAM. The amount of RAM needed depends on the number of concurrent client connections, and whether the server and multiplexor are deployed on the same host.

Client Operating System Requirements

This release supports the following client platforms:

• Solaris 8, 9, and 10

• Microsoft Windows 98, ME, NT (SP 6a), 2000, XP

• Mac OS X, minimum 10.1

• Red Hat Linux, minimum 7.2

Client Software Requirements

On Windows, you can run Instant Messenger using the browser’s Java Plug-in from the following browsers:

• Netscape^TM, minimum 4.79

• Mozilla^TM, minimum 1.2

• Internet Explorer, minimum 5.5

If the client machine has Java 1.4 or later version installed, there are no additional requirements to use either Java Plug-in or Java Web Start. Netscape Navigator v7 as well as the recent versions of the Mozilla browser include Java v1.4 or higher. Internet Explorer does not include the latest version of Java. If you experience problems using the client with Java 1.4, upgrade to 5.0. JDK^TM 5.0 is included with Sun Java System Instant Messaging.

If the client machine does not have Java v1.4 or a higher version installed, you need to install Java Web Start. You can download and install Java v1.4. from the Java Technology website.

You can download and install Java Web Start from the Java Web Start Technology website.

HTML links can be exchanged over Instant Messenger and activated from the messenger by clicking them. When a link is activated, the messenger invokes a browser. Table 3–2 lists supported operating system and browser combinations.

Client Hardware Requirements

Instant Messenger uses between 20 and 40 MB of memory on most platforms. You should estimate the memory requirement by including the requirements of other applications (including operating systems) used on the client machine. In most cases, at least 128 MB RAM is recommended in order to run Instant Messenger and other applications comfortably. This number becomes higher when using memory-intensive operating systems.

Installation Notes

If you choose to use Sun Java System Access Manager to store policies when configuring Instant Messaging, policies like the following are created:

• Ability to administer Instant Messaging and Presence Services

• Ability to change your own Instant Messaging settings

• Ability to manage Instant Messaging Conference Rooms

Compatibility Issues

Table 3–3 lists the known incompatibilities between Instant Messaging 7 2005Q4 and earlier versions.

Documentation Updates

This section contains information about changes to and errors in the documentation in the following sections:

• Documentation Set

• Administration Guide

• Online Help

Documentation Set

The 2005Q4 release of Instant Messaging uses the following version of the Administration Guide:

Sun Java System Instant Messaging 7 2005Q1 Administration Guide

Administration Guide

This section lists the following changes to the Sun Java System Instant Messaging 7 2005Q1 Administration Guide.

• Starting, Stopping, and Refreshing Components in an HA Environment

• Additional Post-Installation Step for Deployments with Access Manager

• Change to Default Value for iim_agent.enable Parameter

• Configuring Calendar Pop-up Reminders for Instant Messenger

• Parameter Removed From iim.conf

• Enabling the Instant Messenger Archive Control Component for Java Plug-in

• Changes for HTML applet pages and pluginLaunch.jsp files

• To Enable Instant Messenger Archive Control for Java Plug-in

• Storing Archived Messages in a Non-default Portal Server Search Database

• Configuring the Server to Allow New User Registration

• Additional Logging Parameter for XMPP Traffic

• High Availability for Instant Messaging

Starting, Stopping, and Refreshing Components in an HA Environment

Do not use the imadmin start, imadmin stop, or imadmin refresh commands in an HA environment with Sun Cluster. Instead, use the Sun Cluster administrative utilities.

Additional Post-Installation Step for Deployments with Access Manager

(Issue Number: 6189148) If you install Access Manager on a different host from the Instant Messaging server, you need to manually copy the imServices_* files from the Instant Messaging server host to the Access Manager host after you run the configure utility.

To do this:

1. Locate the imService_*.properties files on the Instant Messaging server host. By default, these files are located under /opt/SUNWiim/lib/ on Solaris and /opt/sun/im/lib/ on Linux.

2. Copy the files to the locale directory on the Access Manager host. By default this directory is /opt/SUNWam/locale on Solaris and /opt/sun/identity/locale on Linux.

Change to Default Value for iim_agent.enable Parameter

(Issue Number: 5102072) In this release, the default value of the iim_agent.enable parameter has been changed to false. This change is not reflected in the Administration Guide.

Configuring Calendar Pop-up Reminders for Instant Messenger

Step 1 of the procedure “To Configure Instant Messaging Server” is incorrect. No package named SUNWiimag exists. Skip this step.

Parameter Removed From iim.conf

The iim_server.msg_archive.auto configuration parameter is no longer supported although it is incorrectly included in the list of parameters in the Administration Guide.

Enabling the Instant Messenger Archive Control Component for Java Plug-in

(Issue Number: 6244099) The Administration Guide procedure for enabling the Instant Messenger Archive Control component for the Java Plug-in is incorrect. Use the procedure described in Changes for HTML applet pages and pluginLaunch.jsp files instead.

Changes for HTML applet pages and pluginLaunch.jsp files

If you are using Java Plug-in to launch the Instant Messenger, perform the following steps to enable the Instant Messenger Archive Control feature in the Instant Messenger.

To Enable Instant Messenger Archive Control for Java Plug-in

1. Go to the Instant Messenger documentation root directory and locate the im.html and imssl.html files

   By default, the files are installed in the following location:

   /etc/opt/SUNWps/desktop/default/IMProvider

2. Open the .html files in a text editor.

3. Add or edit the following line as required:

   <PARAM NAME="archive_control" VALUE="true" /> <EMBED archive_control=true;/>

Storing Archived Messages in a Non-default Portal Server Search Database

An error occurs in the procedure. Specifically, the following directory:

/etc/opt/SUNWps/desktop/default/IMProvider/

should be:

/etc/opt/SUNWps/desktop/default_locale/IMProvider/

For example:

/etc/opt/SUNWps/desktop/default_ja/IMProvider/

Configuring the Server to Allow New User Registration

The new user registration feature is not completely described in the Administration Guide. In addition to customizing Instant Messenger, you also need to configure the server to allow new user registration.

To do this, you need to add four configuration parameters to iim.conf then refresh the server configuration. Table 3–4 describes the configuration parameters.

To Configure the Server to Allow New User Registration

1. Open iim.conf in a text editor.

2. Add the configuration parameters and appropriate values as described in Table 3–4.

3. Save and close iim.conf.

4. Refresh the server configuration using the imadmin command-line utility.

   imadmin refresh server

   ---

   Caution –

   Do not use the imadmin start, imadmin stop , or imadmin refresh commands in an HA environment with Sun Cluster. Instead, use the Sun Cluster administrative utilities.

   ---

Additional Logging Parameter for XMPP Traffic

(Issue Number: 5070998) An additional undocumented logging parameter has been added to this release to collect XMPP messages in a separate log file.

To Configure the Server to Create the XMPP Message Log

1. Open iim.conf.

   By default, the iim.conf file is installed in the configuration directory as follows:

   • On Solaris:

     /etc/opt/SUNWiim/default/config/iim.conf

   • On Linux:

     /etc/opt/sun/im/default/config/iim.conf

   If you created multiple instances of Instant Messaging, the name of the /default directory will vary depending on the instance.

2. Enable the following line by removing the comment characters:

   iim.log4j.config=log4j.conf

   If the line does not exist, add it.

3. Save and close iim.conf.

4. Create a file named log4j.conf and save it to the configuration directory.

5. Add the following to log4j.conf:

   log4j.logger.xmppd=INFO, A1 # DEFAULT TO RollingFileAppender log4j.appender.A1=org.apache.log4j.RollingFileAppender log4j.appender.A1.file=${logdir}/xmppd.log log4j.appender.A1.append=true log4j.appender.A1.maxBackupIndex=7 log4j.appender.A1.maxFileSize=5mb # More example appenders.. # Straight to console.. # log4j.appender.A1=org.apache.log4j.ConsoleAppender # log4j.appender.A1.ImmediateFlush=true # Rollover at midnight.. # log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender # log4j.appender.A1.DatePattern='.'yyyy-MM-dd # log4j.appender.A1.file=${logdir}/xmppd.log # log4j.appender.A1.ImmediateFlush=true # log4j.appender.A1.append=true # Send to SMTP.. # log4j.appender.A1=org.apache.log4j.SMTPAppender # PATTERN LAYOUT AND OPTIONS # DEFAULT TO PatternLayout log4j.appender.A1.layout=org.apache.log4j.PatternLayout # For full dates.. log4j.appender.A1.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n # IM traditional output format.. #log4j.appender.A1.layout.ConversionPattern=%d{HH:mm:ss,SSS} %-5p %c [%t] %m%n # More example layouts # XMLLayout for chainsaw consumption # log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout # TTCCLayout for NDC information # log4j.appender.A1.layout=org.apache.log4j.xml.TTCCLayout # log4j.appender.A1.layout.DateFormat=ISO8601 # log4j.appender.A1.layout.TimeZoneID=GMT-8:00 # log4j.appender.A1.layout.CategoryPrefixing=false # log4j.appender.A1.layout.ThreadPrinting=false # log4j.appender.A1.layout.ContextPrinting=false # Now we list logger/appender/layout for the other default loggers, but # only the defaults.. log4j.logger.iim_wd=ERROR, A2 log4j.appender.A2=org.apache.log4j.RollingFileAppender log4j.appender.A2.file=${logdir}/iim_wd.log log4j.appender.A2.append=true log4j.appender.A2.maxBackupIndex=7 log4j.appender.A2.maxFileSize=5mb log4j.appender.A2.layout=org.apache.log4j.PatternLayout log4j.appender.A2.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n # For separate xmpp traffic log, disabled by default. log4j.logger.xmppd.xfer=DEBUG, A3 #log4j.appender.A3=org.apache.log4j.varia.NullAppender # Select next block instead of previous line to enable separate transfer log log4j.appender.A3=org.apache.log4j.RollingFileAppender # log4j.appender.A3.file=${logdir}/xfer.log # log4j.appender.A3.append=true # log4j.appender.A3.maxBackupIndex=7 # log4j.appender.A3.maxFileSize=5mb # log4j.appender.A3.layout=org.apache.log4j.PatternLayout # # Note, simpler default output than above 3 loggers: # log4j.appender.A3.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n log4j.logger.agent-calendar=ERROR, A4 log4j.appender.A4=org.apache.log4j.RollingFileAppender log4j.appender.A4.file=${logdir}/agent-calendar.log log4j.appender.A4.append=true log4j.appender.A4.maxBackupIndex=7 log4j.appender.A4.maxFileSize=5mb log4j.appender.A4.layout=org.apache.log4j.PatternLayout log4j.appender.A4.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n log4j.logger.net.outer_planes.jso.BasicStream=OFF, A5 log4j.appender.A5=org.apache.log4j.RollingFileAppender log4j.appender.A5.file=${logdir}/jso.log log4j.appender.A5.append=true log4j.appender.A5.maxBackupIndex=7 log4j.appender.A5.maxFileSize=5mb log4j.appender.A5.layout=org.apache.log4j.PatternLayout log4j.appender.A5.layout.ConversionPattern=[%d{DATE}] %-5p %c [%t] %m%n

6. Save and close log4j.conf.

7. Refresh the server:

   imadmin refresh server

   ---

   Caution –

   Do not use the imadmin start, imadmin stop , or imadmin refresh commands in an HA environment with Sun Cluster. Instead, use the Sun Cluster administrative utilities.

   ---

To Disable Separate XMPP Log File Creation

Disabling separate log file creation does not stop XMPP messages from being written to the server log.

1. Open log4j.conf.

2. Comment out the following line:

   log4j.logger.xmppd.xfer=DEBUG, A3

High Availability for Instant Messaging

Documentation for this feature is available in Configuring Instant Messaging for High Availability (Solaris Only).

Online Help

The following information is not described in either the product online help or the quick reference.

Start Screen

The Start Screen launches Instant Messenger. If you are using Java Web Start, press the Start button in the middle of the screen. If you are using Java Plug-in (for Windows users only), click the Java Plug-in button at the top of the screen. The Online Help and Quick Reference buttons display end user product help.

Problems Fixed in This Release

Table 3–5 describes problems fixed in this Instant Messaging 7 2005Q4 release.

Known Issues and Limitations

This section contains a list of the more important known issues at the time of the Instant Messaging 7 2005Q4 release.

Patch updates are issued on a frequent basis. If you encounter a problem while installing or using Instant Messaging, contact Sun Support to enquire about the availability of a fix for this problem. Alternatively, you can consult SunSolve Online for patches.

Table 3–6 lists the known issues and limitations.

WARNING: Cannot parse rpm files
by running "/bin/rpm -qp --queryformat

CollaborationSessionFactory factory=new
CollaborationSessionFactory("com.iplanet.im.client.api.iIMSessionFactory");

com.sun.im.service.xmpp.session.keepaliveinterval

Configuring Instant Messaging for High Availability (Solaris Only)

Configuring Instant Messaging for high availability (HA) provides for monitoring of and recovery from software and hardware failures. The high availability feature is implemented as a failover data service, not a scalable service, and is supported on Solaris only. This section describes an Instant MessagingHA configuration using Sun Cluster software. See HA Related Documentation for more information about data services provided by Sun Cluster.

This describes how to configure an Instant Messaging HA service, in the following sections:

• Instant Messaging HA Overview

• Setting Up HA for Instant Messaging

• Stopping, Starting, and Restarting the Instant Messaging HA Service

• Managing the HA RTR File for Instant Messaging

• Removing HA for Instant Messaging

• HA Related Documentation

Instant Messaging HA Overview

You use Sun Cluster with Instant Messaging to create a highly available deployment. This section provides information about HA requirements, terms used in examples in this chapter, and permissions you need to configure HA in the following sections:

Before you begin, you should be familiar with general HA concepts, and Sun Cluster software in particular. For more information, see HA Related Documentation.

HA Configuration Software Requirements

An Instant Messaging HA configuration requires the software shown in Table 3–7.

HA Configuration Permission Requirements

To install and configure an Instant Messaging HA configuration, log in as or become superuser (root) and specify a console or window for viewing messages sent to /dev/console.

HA Configuration Terms and Checklist

Table 3–8 describes the variable terms used in the examples in this chapter for configuration examples. In addition, you will need to gather the information before you configure HA for Instant Messaging. You will be prompted for this information during configuration. Use this checklist in conjunction with the checklist in Chapter 1 of the Sun Java System Instant Messaging 7 2005Q1 Administration Guide.

Setting Up HA for Instant Messaging

The following is a high-level list of the steps necessary to install and configure an Instant Messaging HA configuration with two nodes:

• Choosing a Local or Shared Disk for Configuration Files and Binaries

• Preparing Each Node in the Cluster

• Selecting the Installation Directory (im_svr_base )

• Installing Instant Messaging Products and Packages

• Configuring the HA Environment

• Configuring the Logical Host

• Registering and Activating the Storage Resource

• Registering the Resource Type and Creating a Resource

• Verifying the Instant Messaging HA Configuration

• Troubleshooting the Instant Messaging HA Configuration

Choosing a Local or Shared Disk for Configuration Files and Binaries

Before you begin, you need to decide which of the following deployments best suits your needs. In both environments, shared components are installed locally on every node in the cluster. In addition, in both environments, runtime files are installed on a shared disk.

• Using a local disk for configuration files and binaries. The advantage to this setup is that upgrading Instant Messaging requires minimal downtime because you can upgrade on nodes where Instant Messaging is offline. The disadvantage is that you need to ensure that the same configuration and version of Instant Messaging exists on all nodes in the cluster.

  In addition, if you choose this option, you need to determine whether you will be using HAStoragePlus to mount a file system from a shared disk on each node when Instant Messaging data services are brought online, or if you will be using the cluster file system for global runtime files.

• Using a shared disk for configuration files and binaries. This setup is easier to administer, but you need to bring Instant Messaging down on all nodes in the cluster before upgrading.

Preparing Each Node in the Cluster

On each node in the cluster, you need to create the Instant Messaging runtime user and group under which the components will run. The UID and GID numbers must be the same on all nodes in the cluster.

• Runtime User ID. The user name under which Instant Messaging server runs. This name should not be root. The default is inetuser.

• Runtime Group ID. The group under which Instant Messaging server runs. The default is inetgroup.

  Although the configure utility can create these names for you, you can create them before you run the configuration program, as part of the preparation of each node as described in this chapter. In addition, depending on whether you are using a local or shared disk, you may not run configure on a particular node and must manually create the runtime user and group ID.

  The runtime user and group ID names must be in the following files:

• inetuser, or the name you select, in /etc/passwd on all nodes in the cluster

• inetgroup, or the name you select, in /etc/group on all nodes in the cluster

See the Sun Java System Instant Messaging 7 2005Q1 Administration Guide for instructions. Refer to your operating system documentation for detailed information about users and groups.

Selecting the Installation Directory (im_svr_base )

For Instant Messaging, the Java Enterprise System installer uses /opt/SUNWiim on Solaris as the default installation directory (im_svr_base ). However, if you are using a shared disk for configuration files and binaries, you must specify a global (shared) installation directory. For example: /global/im/opt/SUNWiim.

If you are using a local disk, you can install Instant Messaging to the default directory. However, you should Install Instant Messaging in the same directory on each machine in the node.

Installing Instant Messaging Products and Packages

You install products and packages using the Sun Java Enterprise System installer program. For more information about the installer, refer to the Sun Java Enterprise System 2005Q4 Installation Guide.

Table 3–9 lists the products or packages required for a multiple node cluster configuration.

Configuring the HA Environment

The steps you need to perform vary depending on whether or not you are using a local or shared disk for configuration files and binaries.

If you are using a local disk for configuration files and binaries, follow the steps in the following two procedures:

• To Configure HA on Node 1 Using a Local Disk for Configuration Files and Binaries

• To Configure HA on Node n Using a Local Disk for Configuration Files and Binaries

If you are using a shared disk for configuration files and binaries, follow the steps in the following two procedures:

• To Configure HA on Node 1 Using a Shared Disk for Configuration Files and Binaries

• To Configure HA on Node n Using a Shared Disk for Configuration Files and Binaries

To Configure HA on Node 1 Using a Local Disk for Configuration Files and Binaries

Before You Begin

Fill out the checklists in Chapter 1 of the Sun Java System Instant Messaging 7 2005Q1 Administration Guide and Table 3–8 and have your answers readily available.

1. Install products and packages using the Java Enterprise System installer.

   See Selecting the Installation Directory (im_svr_base ) for specific instructions on choosing an installation directory.

   See Table 3–9 for a list of required products and packages for HA. Refer to the Sun Java Enterprise System 2005Q4 Installation Guide for specific instructions.

2. If you are using HAStoragePlus for the runtime files, mount a shared disk to a local directory, otherwise skip to Step 3.

   For example:

   1. Create the mount point (/local/ im/im_runtime_base/) if it does not already exist.

      When prompted during configuration in Step 4 you will specify this directory (/local /im/im_runtime_base/ ) as the Instant Messaging Server Runtime Files Directory.

   2. Use the mount command to mount the disk on /local/im/im_runtime_base.

3. Run the configure utility.

   See the Sun Java System Instant Messaging 7 2005Q1 Administration Guide for instructions.

4. When prompted for the Instant Messaging Server Runtime Files Directory, enter one of the following:

   • If you are using an HAStoragePlus for the runtime files, enter /local/im/im_runtime_base /.

   • If you are using a cluster file system for the runtime files, enter /global/im/im_runtime_base /. Where /global/ im is the global directory in the cluster file system.

5. When prompted for the Instant Messaging host name, enter the logical host.

   Choose to accept the logical host even if the configure utility cannot connect to the specified host. The logical host resource may be offline at the time you run the configure utility.

6. Do not choose to start Instant Messaging after configuration or on system startup.

   In an HA configuration, the Instant Messaging service also requires the logical host to be online for Instant Messaging to work properly.

7. If you are using HAStoragePlus for runtime files, unmount the shared disk.

To Configure HA on Node n Using a Local Disk for Configuration Files and Binaries

Before You Begin

Ensure that you have completed HA configuration on Node 1 as described in the previous procedure (To Configure HA on Node 1 Using a Local Disk for Configuration Files and Binaries).

Have your answers for the checklists in Chapter 1 of the Sun Java System Instant Messaging 7 2005Q1 Administration Guide and Table 3–8 readily available.

1. Install products and packages using the Java Enterprise System installer.

   Choose the same path you used when you installed Instant Messaging on node 1 for each subsequent node in the cluster. See Selecting the Installation Directory (im_svr_base ) for specific instructions.

   See Table 3–9 for a list of required products and packages for HA. Refer to the Sun Java Enterprise System 2005Q4 Installation Guide for specific instructions.

2. Run the configure utility.

   See Chapter 1 of the Sun Java System Instant Messaging 7 2005Q1 Administration Guide for instructions.

3. When prompted for the Instant Messaging Server Runtime Files Directory, enter the same value that you provided for Node 1.

4. When prompted for the Instant Messaging host name, enter the same logical host you provided for Node 1.

   Choose to accept the logical host even if the configure utility cannot connect to the specified host. The logical host resource may be offline at the time you run the configure utility.

5. When prompted for the user and group, enter the same value that you provided for Node 1.

6. Do not choose to start Instant Messaging after configuration or on system startup.

   In an HA configuration, the Instant Messaging service also requires the logical host to be online for Instant Messaging to work properly.

To Configure HA on Node 1 Using a Shared Disk for Configuration Files and Binaries

Before You Begin

Fill out the checklists in Chapter 1 of the Sun Java System Instant Messaging 7 2005Q1 Administration Guide and Table 3–8 and have your answers readily available.

You must use a cluster file system if you are using a shared disk for configuration files and binaries, not HAStoragePlus.

1. Install products and packages in a directory in the cluster file system using the Java Enterprise System installer.

   When you install Instant Messaging, you must specify a directory other than the default directory. See Selecting the Installation Directory (im_svr_base ) for specific instructions.

   See Table 3–9 for a list of required products and packages for HA. Refer to the Sun Java Enterprise System 2005Q4 Installation Guide for specific instructions.

2. Create a soft link from /etc/opt/SUNWiim that points to /global/im/etc/opt/SUNWiim .

3. Run the configure utility from the global directory where you installed Instant Messaging (/global/ im/im_svr_base/configure ).

   See Chapter 1 of the Sun Java System Instant Messaging 7 2005Q1 Administration Guide for instructions.

4. When prompted for the Instant Messaging Server Runtime Files Directory, enter the value for /global/im/ im_runtime_base.

5. When prompted for the Instant Messaging host name, enter the logical host.

   Choose to accept the logical host even if the configure utility cannot connect to the specified host. The logical host resource may be offline at the time you run the configure utility.

6. Do not choose to start Instant Messaging after configuration or on system startup.

   In an HA configuration, the Instant Messaging service also requires the logical host to be online for Instant Messaging to work properly.

To Configure HA on Node n Using a Shared Disk for Configuration Files and Binaries

Before You Begin

Ensure that you have completed HA configuration on Node 1 as described in the previous procedure (To Configure HA on Node 1 Using a Shared Disk for Configuration Files and Binaries).

Have your answers for the checklists in Chapter 1 of the Sun Java System Instant Messaging 7 2005Q1 Administration Guide and Table 3–8 readily available.

1. Create a soft link from /etc/opt/SUNWiim that points to /global/im/etc/opt/SUNWiim .

2. Create a soft link for the resource type registration (RTR) file:

   ln -s /global/im/ im_svr_base/cluster/SUNW.iim \ /usr/cluster/lib/rgm/rtreg/SUNW.iim

Configuring the Logical Host

Before starting Instant Messaging, you need to create a resource group, add the logical host, and bring the resource group online.

To Configure the Resource Group With the Logical Host

1. Create an Instant Messaging failover resource group named im_resource_group:

   # scrgadm -a -g im_resource_group -h im-node-2,im-node-1

2. Add the logical host name im_logical_host to the resource group.

   Instant Messaging will listen on this host name.

   # scrgadm -a -L -g im_resource_group -l im_logical_host

3. Bring the resource group online:

   # scswitch -Z -g im_resource_group

Registering and Activating the Storage Resource

Before you can bring the Instant Messaging data service online, you need to register and activate the storage resource as described in this section.

To Register and Enable the Storage Resource

1. Register the storage resource.

   If you are using HAStoragePlus with a global file system (GFS), set the mount point as the value for the FileSystemMountPoints property. For example:

   # scrgadm -a -j im_resource_group_store -g im_resource_group -t SUNW.HAStorage \ -x FileSystemMountPoints=/global/ im -x AffinityOn=True

   Otherwise, specify the mount point as the value for the ServicePaths property. For example:

   # scrgadm -a -j im-resource-group-store -g im-resource-group -t SUNW.HAStorage \ -x ServicePaths=/global/im -x AffinityOn=True

2. Enable the storage resource:

   # scswitch -e -j im_resource_group_store

Registering the Resource Type and Creating a Resource

Before you start the HA Instant Messaging server or multiplexor, you need to register the resource type SUNWiimsc with Sun Cluster and create a resource.

To Register the Resource Type and Create a Resource

1. Register the resource type.

   # scrgadm -a -t SUNW.iim

2. Create the resource.

   Enter the following command on a single line:

   # scrgadm -a -j im_resource -g im_resource_group -t SUNW.iim -x Confdir_list=/global/im/ im_resource_group -y Resource_dependencies=im_resource_group_store -y Port_list=80/tcp

3. Enable the resource:

   # scswitch -e -j im_resource

4. Start Instant Messaging components.

   ---

   Caution –

   Do not use the imadmin start, imadmin stop , or imadmin refresh commands in an HA environment with Sun Cluster. Instead, use the Sun Cluster administrative utilities.

   ---

Verifying the Instant Messaging HA Configuration

After you start Instant Messaging, you need to verify the HA configuration as described in this section.

To Verify the HA Configuration for Instant Messaging

1. Check that all required processes are running.

2. Conduct a switchover of the service to the backup node to ensure the high availability.

   For example, if the service is running on im_node_1, issue the following command to switch the service to im_node_2.

   # scswitch -z -g im_resource_group -h im_node_2

3. Check that all required processes are started on im_node_2 .

Troubleshooting the Instant Messaging HA Configuration

To help with troubleshooting, error messages are written to the error log. The logs are controlled by the syslog facility. For information about using the logging facility, refer to the HA Related Documentation and to the man page for syslog.conf.

Stopping, Starting, and Restarting the Instant Messaging HA Service

To start and stop the Instant Messaging HA service, use the Sun Cluster scswitch command.

Do not use the imadmin start, imadmin stop , or imadmin refresh commands in an HA environment with Sun Cluster. Instead, use the Sun Cluster administrative utilities.

For more information about the Sun Cluster scswitch command, refer to the Sun Cluster Reference Manual for Solaris OS.

To Start the Instant Messaging HA Service

Type the following at the command line:

# scswitch -e -j im_resource

To Stop the Instant Messaging HA Service

Type the following at the command line:

# scswitch -n -j im_resource

To Restart the Instant Messaging HA Service

Type the following at the command line:

# scswitch -R -j im_resource

Managing the HA RTR File for Instant Messaging

The resource type registration (RTR) file is an ASCII text file that describes a highly-available resource type that runs under the control of the Resource Group Manager (RGM). The RTR file is used as an input file by the scrgadm command to register the resource type into the cluster configuration. The Instant Messaging RTR file, SUNW.iim, is created when you install the SUNWiimsc package during HA configuration.

This section provides information about managing this file in the following sections:

• Instant Messaging RTR File Parameters

• Customizing the RTR File for Instant Messaging

Instant Messaging RTR File Parameters

The following table lists the extension properties in the Instant Messaging RTR file (SUNW.iim) that are specific to Instant Messaging.

Customizing the RTR File for Instant Messaging

You can modify the values for several of the extension properties in the Instant Messaging RTR file (SUNW.iim) to configure your HA environment. Extension properties are properties that are specific to the resource type. These properties are inherited by every resource of the same type. Instant Messaging extension properties are described in Instant Messaging RTR File Parameters.

See the documentation for rt_reg and property_attributes in the Sun Cluster Reference Manual for Solaris OS for more information on the contents of resource type registration files and instructions on customizing values for extension properties.

Removing HA for Instant Messaging

In order to remove Instant Messaging from an HA environment, you need to remove the Instant Messaging cluster agent SUNWiimsc as described in this section.

To Remove HA for Instant Messaging

Before You Begin

When you remove the SUNWiimsc package as described in this procedure, any customizations you made to the RTR file SUNW.iim are lost. If you want to restore them at a later time, you need to create a backup copy of SUNW.iim before removing the SUNWiimsc package.

1. Bring down the Instant Messaging data service:

   scswitch -F -g im_resource_group

2. Disable all resources in the Instant Messaging resource group ( im_resource_group):

   # scswitch -n -j im_resource # scswitch -n -j im_logical_host # scswitch -n -j im_resource_group_store

3. Remove the resources from the Instant Messaging resource group:

   # scrgadm -r -j im_resource # scrgadm -r -j im_logical_host # scrgadm -r -j im_resource_group_store

4. Remove the Instant Messaging resource group:

   # scrgadm -r -g im_resource_group

5. Remove the Instant Messaging resource type:

   # scrgadm -r -t SUNW.iim

6. Remove the SUNWiimsc package using the Java Enterprise System installer or manually as follows:

   pkgrm SUNWiimsc

   When you remove the package, any customizations you made to the RTR file are lost.

7. If you are using a shared directory for configuration files and binaries, remove any soft links created during HA configuration.

   On Node 1:

   rm /etc/opt/SUNWiim

   On all other nodes:

   rm /usr/cluster/lib/rgm/rtreg/SUNW.iim

HA Related Documentation

• Sun Java System Instant Messaging 7 2005Q1 Administration Guide

• Sun Java Enterprise System 2005Q4 Technical Overview

• Sun Java Enterprise System 2005Q4 Installation Guide for UNIX describes the Java Enterprise System installer (and uninstaller) and the supported installation scenarios.

• Sun Java Enterprise System 2005Q4 Release Notes provide current information about the Sun Java Enterprise System product.

• Sun Cluster Concepts Guide for Solaris OS provides a general background about Sun Cluster software, data services, and terminology resource types, resources, and resource groups.

• Sun Cluster Data Services Planning and Administration Guide for Solaris OS provides general information on planning and administration of data services.

• Sun Cluster System Administration Guide for Solaris OS provides the software procedures for administering a Sun Cluster configuration.

• Sun Cluster Reference Manual for Solaris OS describes the commands and utilities available with the Sun Cluster software, including commands found only in the SUNWscman and SUNWccon packages.

• Sun Java System Communications Services 6 2005Q4 Deployment Planning Guide provides further information about how HA is implemented in Instant Messaging.

Redistributable Files

Sun Java System Instant Messaging 7 2005Q4 does not contain any files which you can redistribute.