Halcyon PrimeAlert (R) for Sun Cluster 2.2 
                            Version 1.0.0
                  For use with Sun Management Center

                               README
-----------------------------------------------------------------------

Included Components
===================

This distribution includes the following PrimeAlert modules:

PrimeAlert for Sun Cluster 2.2
PrimeAlert LogFileMonitor
PrimeAlert ProcessMonitor

These three modules are installed together because PrimeAlert for Sun
Cluster 2.2 employs some of the functionality provided by the other two
modules.


Nomenclature
============

- 'Sun Management Center' was formerly called 'Sun Enterprise SyMON'.
  This product only supports Sun Management Center 2.1 or higher.


Supported Platforms
===================

The following table summarizes the platform support for the various
components contained within this distribution:

Operating            Base               Agent  Server  Console
System               Product            Layer  Layer   Layer
-------------------  -----------------  -----  ------  -------
Solaris 2.5.1        SunMC 2.1.x/3.0      x
Solaris 2.6-2.8      SunMC 2.1.x/3.0      x      x        x
Windows NT 4.0/2000  SunMC 2.1.x/3.0                      x


Informational Text Files
========================

A number of useful informational text files are included with this
distribution:

  - README
  - README.install
  - TroubleShooting
  - ReleaseNotes
  - LICENSE
  - COPYRIGHT

These files are located in the base directory of the distribution
tarball, and after installation, in the directory:

  After installation on a Solaris host -
    /var/opt/SUNWsymon/install/HALSunCluster22

  After installing the module's console layer on a Windows host -
    C:\Program Files\Halcyon\PrimeAlert\docs\HALSunCluster22


Installation and Uninstallation Instructions
============================================

For installation or uninstallation instructions, refer to the file
README.install (see the above section 'Informational Text Files').


Troubleshooting
===============

For troubleshooting information, refer to the TroubleShooting file
(see the above section 'Informational Text Files').

The release notes file, ReleaseNotes, which is located in the same
places as the TroubleShooting file, is also a valuable reference.
It contains information about bug fixes, enhancements, known problems,
and upgrade strategy for the current release.


HTML Help Documentation
=======================

To view the Help documentation for each of the three modules included
in this distribution, open the following file in the "doc" subdirectory
of the HALsmxsc2_1.0.0 directory in the tar file HALsmxsc2_1.0.0.tar:

./doc/SunCluster22/HALSunCluster22-h.html
./doc/LogFileMonitor/HALLogFileAlert-h.html
./doc/ProcessMonitor/HALProcessAlert-h.html

This documentation is also available by selecting "Help" from a
module's pop-up menu in the console's Details window.


License
=======

Please read the license agreement in the file LICENSE located in this
directory.

Without purchasing a license, the three modules included in this
distribution will only operate for a trial period of 30 days.

If you wish to purchase a license to use PrimeAlert for Sun Cluster 2.2,
please contact us at:

  Halcyon Monitoring Solutions, Inc.
  2300 Yonge Street
  Suite 1801, Box 2419
  Toronto, Ontario  M4P 1E4
  Canada

  http://www.HalcyonInc.com
  mailto:info@HalcyonInc.com
  Tel: 416-932-4647
  Fax: 416-932-4711


Overview
========

PrimeAlert for Sun Cluster 2.2 monitors the health of a Sun Cluster 2.2
node, and the cluster itself. The module monitors the local physical
host, the cluster logical and physical hosts, the local network
connections, the local cluster processes, and the local cluster syslog
messages.

Monitoring a Cluster with Sun Management Center
-----------------------------------------------

This sub-section suggests various, possibly helpful, practices for
monitoring a Sun Cluster 2.2 environment with Sun Management Center.

a) Monitoring usage of the /var filesystem

Sun Cluster 2.2 makes extensive use of the syslog file
/var/adm/messages. Therefore, it is highly recommended that the user
make use of Sun's 'Kernel Reader' module; this includes loading Kernel
Reader on each cluster node, reviewing the alarm thresholds set on the
/var filesystem in the 'Filesystem Usage' section, and configuring
appropriate alarm or event notifications. 

b) Logical host monitoring from outside of the cluster

The purpose of a cluster is to provide high availability data services
to entities external to the cluster, while PrimeAlert for Sun Cluster 2.2
resides on nodes that are internal to the cluster. It is therefore
highly recommended that the user load PrimeAlert ScriptRunner on a host
that is external to the cluster, and configure ScriptRunner to
periodically ping each logical host in the cluster; appropriate alarm
or event notifications should be configured for the situation where a
logical host cannot be pinged from an external host.

c) Synchronizing attribute changes between cluster nodes

If you are using Sun Management Center 2.1.x, and wish to configure
all cluster node agents in an identical fashion, here is a simple
method for propagating templated agent configurations to all cluster
nodes. First, load and configure all required modules on a node that
has access to all objects to be monitored. Then, for each configured
module, copy the file /var/opt/SUNWsymon/cfg/<module>.dat from the
'template' agent to the 'clone' agents on all the other nodes. After
restarting the 'clone' agents, all loaded modules will be identically
configured to those on the 'template' agent. Note that the clone
agents may not have current access to all objects that are available
to the template agent.

If you are using PrimeAlert for Veritas Volume Manager on your
cluster nodes, contact Halcyon for detailed instructions on configuring
module alarm limits for the various nodes that comprise the cluster.

Note that SunMC 3.0 has a module configuration propagation facility to
simplify templated agent configurations. This feature is available as
part of the Premier monitoring package of SunMC 3.0. (SunMC 3.0 has
three available levels of monitoring, Basic, Advanced, and Premier.)


Loading an Instance of PrimeAlert for Sun Cluster 2.2 
=====================================================

1. Launch the Sun Management Center console application, and select a
   domain that contains the host where PrimeAlert for Sun Cluster 2.2
   will be loaded.

2. In a Host Details window, select "Load Module..." from the Module
   Menu (or, in the Main console window, select "Load Module..." from a
   host's Pop-up Menu).

3. Select PrimeAlert for Sun Cluster 2.2 from the Module Picklist and 
   click on the OK button. This will launch the Module Loader which
   contains the following fields:

Module
              The name of the module assigned to files as part of the
              module file naming convention. This field is read-only.

Module Name
              The actual name of the module. This field is read-only.

Module Description
              The short description of the module. This field is
              read-only.

Version
              The version number of the module. This field is
              read-only.

Enterprise
              The Enterprise where this module will be loaded in the
              agent's MIB. This field is read-only.

Module Type
              The module's type, which determines where this module
              will appear in the module hierarchy. This field is
              read-only.

Cluster Name
              The official, technical cluster name, as you would use
              with the command "scconf <cluster name> -p".

Log File
              The syslog file to which the cluster is logging its
              messages. By default, the log file is /var/adm/messages.

Path to Sun Cluster Binaries

              The directories where the various Sun Cluster 2.2
              administrative-command binaries are located. The list of
              binaries includes: get_ha_status, haget, scconf, hastat,
              pnmstat, and get_node_status.

              The default value for this parameter is
              /opt/SUNWcluster/bin:/opt/SUNWpnm/bin

4. Once you have entered the required information, click on the OK
   button to load the module.

---//---