#
# @(#)file      README
# @(#)author    Sun Microsystems, Inc.
# @(#)version   1.8
# @(#)date      02/01/02
#
# Copyright 2001 Sun Microsystems, Inc. All rights reserved.
#

--------------------------------------------------------------------------------
            Netra(TM) High Availability Suite 2.0 (Netra HAS 2.0)

          Management Agent  Graphical Monitoring Interface (MA GMI)
--------------------------------------------------------------------------------


##
# UNSUPPORTED CONTRIBUTION SOFTWARE NOTICE
#
# The Netra HAS 2.0 MA GMI software is provided as an unsupported contribution
# to the Netra HA Suite 2.0 software. 
#
# Sun Microsystems will not provide technical support for this software.
##



I. DESCRIPTION
   -----------
   
   The Netra HAS 2.0 Management Agent Graphical Monitoring Interface (MA GMI)
   is a Graphical User Interface (GUI) which exposes the states and statistics 
   on all the nodes of a Netra HAS 2.0 cluster.



II. INSTALLATION
    ------------
    
   Install package SUNWnhmau which contains this GMI contribution, 
   packages SUNW2jdrt and SUNWnhmaj, and patch 112045-02 (cf. section III 
   DEPENDENCIES)  on a host which has network access to the nodes of the   
   Netra HAS 2.0 cluster to be monitored.

   Eg. for a default install:
   # pkgadd -d <pkgs_dir> SUNWnhmau SUNW2jdrt SUNWnhmaj
   # patchadd <patches_dir>/112045-02

   After installation completes, the GMI part of SUNWnhmau package is then 
   available in the root GMI directory:

   /opt/SUNWcgha/contribs/ma_gmi/
   
   The contents of the root GMI directory are:
  ./README       : this README
  ./bin/gmi.sh   : GMI startup script
  ./etc/gmi.conf : GMI configuration file
  ./lib/gmi.jar  : GMI Java classes jar file


    
III. DEPENDENCIES
     ------------

  Netra HAS 2.0 MA GMI has been compiled and tested on JDK 1.3.1,
  and requires at least JDK 1.3.1.

  Netra HAS 2.0 MA GMI has dependencies on the jar files listed below, 
  which are expected to be accessible from GMI classpath (see section IV. STARTUP).
  Absolute paths given correspond to a default install:

  * From package SUNW2jdrt : Java Dynamic Management(TM) Kit 4.2 for the Java(TM) 2 Platform
    with patch 112045-02 applied
      /opt/SUNWjdmk/jdmk4.2/1.2/lib/jdmkrt.jar

  * From package SUNWnhmaj : Netra HAS 2.0 Management Agent java classes
      /opt/SUNWcgha/lib/ma.jar
      /opt/SUNWcgha/lib/jcmm.jar
      /opt/SUNWcgha/lib/cghautil.jar

  
  Additionnally, GMI automatically displays a specific view of the cluster 
  MASTER node if the MA Master MBeans contribution has been activated on each
  node of the cluster. For instructions on how to do so, see the README of the 
  MA Master MBeans contribution (also in package SUNWnhmau).



IV. STARTUP
    -------
    
    Current directory ./ is the root GMI directory 
    (ie /opt/SUNWcgha/contribs/ma_gmi for a default install).

1) cd ./bin

2) edit gmi.sh and set the following variables to the correct paths on your host.
   Default values are those expected  with a default installation of the 
   necessary packages:
     GMI_ROOT  = /opt/SUNWcgha/contribs/ma_gmi
     JDMK_ROOT = /opt/SUNWjdmk/jdmk4.2/1.2
     MA_ROOT   = /opt/SUNWcgha
     JDK_ROOT  = /usr/j2se

3) edit ./etc/gmi.conf to set : 
   - the local host on which gmi runs (this is needed so as gmi can revceive notifications)
   - the cluster_hosts and http_port or rmi_port used for connection
     (default http_port on 8081)
   - the master_host and the master_port used for connection
     (default port 8081)
 
4) cd ./bin
 
   sh gmi.sh
	or
   sh gmi.sh [local_host local_host]
	     [cluster_hosts "host1,host2,host3,.."] 
	     [http_port port | rmi_port port rmi_server_hostname host]
	     [master_host master_host] 
	     [master_port]

   [command line parameter values have precedence over gmi.conf parameter values]

V.USAGE NOTES
  -----------
   GMI may freeze for about 10 seconds when a failover or a switchover appears, this is due to socket timeout, we hope to solve this a futur version.


--
