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 Sun Java^TM System 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 Creating a UNIX System User and Group 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 Sun Java^TM System Products and Packages

You install products and packages using the Communications Suite installer program. For more information about the installer, refer to the Sun Java Communications Suite 5 Installation Guide.

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

Table 4–3 Products and Packages Required for a Multiple Node Instant Messaging HA Configuration

Product or Package	Node 1	Node n
Sun Cluster Software	Yes	Yes
Instant Messaging 7.2 Server	Yes	Yes, if you are using a local disk for configuration files and binaries. No, if you are using a shared disk for configuration files and binaries.
Sun Cluster Agent for Instant Messaging  (SUNWiimsc)	Yes	Yes, if you are using a local disk for configuration files and binaries. No, if you are using a shared disk for configuration files and binaries.
Shared components   If you are using HAStoragePlus, you must also install SUNWscu	Yes	Yes

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 Table 1–1 and Table 4–2 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 4–3 for a list of required products and packages for HA. Refer to the Sun Java Communications Suite 5 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 Chapter 1, Configuring Instant Messaging After Installation 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 Table 1–1 and Table 4–2 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 4–3 for a list of required products and packages for HA. Refer to the Sun Java Communications Suite 5 Installation Guide for specific instructions.

2. Run the configure utility.

   See Chapter 1, Configuring Instant Messaging After Installation 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 Table 1–1 and Table 4–2 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 4–3 for a list of required products and packages for HA. Refer to theSun Java Communications Suite 5 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, Configuring Instant Messaging After Installation 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 Table 1–1 and Table 4–2 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

3. Enable the resource:

   # scswitch -e -j im-resource

4. Start Instant Messaging components.

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.