/
/ $Header: has/crfutl/README_gui.txt /st_has_ipd-1.0.3.1/2 2012/03/09 10:28:43 anutripa Exp $
/
/ README_gui.txt
/
/ Copyright (c) 2012, Oracle. All Rights Reserved.
/
/   NAME
/     README_gui.txt - <Readme for CHMOSG install>
/
/   DESCRIPTION
/
/   NOTES
/     <other useful comments, qualifications, etc.>
/
/   MODIFIED   (MM/DD/YY)
/   anutripa    03/08/12 - Change user manual name for GUI
/   anutripa    02/16/12 - README FOR GUI
/   anutripa    02/16/12 - Creation
/
I. INTRODUCTION

Oracle Cluster Health Monitor - UI (CHMOSG)
--------------------------------------------------------------------------------

CHMOSG is designed to be a GUI to CHM/OS which detects and analyzes operating
system (OS) and cluster resources related degradation and failures in order to
improve diagnosibility of Oracle Clusterware and Oracle RAC issues such as a
node
eviction.

CHMOSG is written enitely in Java but requires access to Oracle Clusterware
libraries in order to communicate with CHM/OS.

NOTE: This CHM/OS Graphical User Interface (CHMOSG) is not a part of any
Oracle
Grid Infrastructure release. It ships separately on OTN. Please review this
included README for required O/S level and Grid Infrastructure versions.
Beginning with the 11.2.0.2 release of the Oracle Grid Infrastructure,
CHMOSG must be installed and run on a local node of the cluster to be
monitored.
The standalone version of CHM/OS provides a proxy process, oproxyd,that
supports
connecting to ologgerd from a remote node outside the cluster. However, that
node
must have a standalone installation of CHM/OS. Running CHMOSG remotely has the
advantage of reducing the CPU usage that a Java-based GUI can impose on a
monitored node; however, the process names and associated metrics
are not encrypted and thus would be transmitted on the public network.


II. INSTALLATION

NOTE: References to the install home in this README, assume /usr/lib/oracrf
      on Linux and "C:\Program Files\oracrf" on Windows for standalone
install.

1. Unzip chm_os_ui.zip into a new subdirectory of the home directory.

Usage: chminstall -i <ui install dir>
                  -d
                  -h
where
                  -i : Install GUI at <ui_install_dir>.
    <ui install dir> : Mandatory path to the existing installation
                       directory.
                  -d : De-install the GUI installtion where the script is run.
                  -h : show this help.


2. The installation requires setting a CRFPERLBIN environment variable to the
   location of a perl version greater than or equal to 5.6.0.
   Bash Example: export CRFPERLBIN=/usr/bin

4. The runtime requires a Java 1.5 or higher runtime. If CHMOSG is not being 
   installed on a server running Oracle Clusterware 11.2.0.2+, then the 
   CRF_JAVA_HOME variable needs to be set.

      Bash Example: export CRF_JAVA_HOME=/opt/jdk

5. Create an installation directory for CHMOSG.
      
      Example: mkdir /usr/lib/oracf/chmosg 

   NOTE: this directory must be writeable by any user running CHMSOG.

6. From the install subdirectory of the unzipped archive run the installation
   script:

     Linux Example: chminstall -i /usr/lib/oracf/chmosg

7. Run CHMOSG by reviewing the User Manual located in the /doc sub-directory

     Example: firefox doc/chmosg_userman.html

 Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.