Installing InfoHub

This section contains information about installing and creating an environment configuration for InfoHub.

InfoHub is available under the terms of the Affero GNU General Public License (AGPL) version 3, from Source Forge ( http://sourceforge.net/projects/fis-gtm). Contact FIS if you wish to obtain InfoHub under the terms of another license.

Ensure that you have a correctly configured installation of the following software:

Software

Minimum Version

Notes

GT.M

V6.0-002 or above

InfoHub requires a correctly installed distribution for GT.M V6.0-002 or above. For information on installing GT.M, refer to "Installing GT.M" chapter of the UNIX Administration and Operations Guide.

gtmposix

63250_37800

InfoHub requires a correctly built gtmposix plugin.

Infohub uses the gtmposix plugin to access POSIX functions available on POSIX platforms (UNIX/Linux). For more information on installing the gtmposix plugin, refer to readme.txt available in the gtmposix distribution available on sourceforge.net.

Find or create a directory to hold your InfoHub distribution files and make that your current directory.

Example:

$ cd /opt

Unpack the InfoHub distribution to the current directory with a command such as the following (your UNIX version may require you to first use gzip to decompress the archive and then tar to unpack it; the tar options may also vary):

$ tar zxvf /Distrib/InfoHub/InfoHub.63344_62100.tar.gz
$ mkdir /opt/InfoHub/configs

Congratulations! InfoHub is now unpacked in the /opt/InfoHub directory. Proceed to InfoHub Environment Setup to set up a default environment.

Your InfoHub distribution comes with three Bourne shell environment setup scripts that automatically define InfoHub environment variables and display the commands to create an InfoHub database and a global directory if they do not already exist. These scripts are designed to give you a friendly out-of-the-box InfoHub operations experience. Even though you can perform normal InfoHub operations without using these scripts, it is important to go through these scripts to understand the how to manage environment configuration for InfoHub. These scripts are as follows:

infohub_site.sh

Contains placeholders for defining ihsrcdir (the source directory of your InfoHub distribution), gtmgbldir (the InfoHub global directory which resides in the same directory as the InfoHub database and services), and gtm_dist (the GT.M distribution used to run InfoHub).

infohub_profile.sh

Sources $HOME/infohub_site.sh, creates an environment for InfoHub using the environment variables defined in infohub_site.sh. It displays commands to create an InfoHub database and global directory if they do not already exist. When it detects a misconfiguration, it displays the misconfigured environment variable name and stops execution.

To use these environment setup scripts, perform the following steps:

  1. Copy infohub_site.sh to $HOME/.infohub_site.sh.

  2. Use your favorite editor to open $HOME/.infohub_site.sh or customize it in place as 'custom_infohub_site.sh' and set appropriate values for:

  3. Source infohub_profile.sh on the command line or add the following command in your ~/.profile. 

    $ source /path/to/infohub_profile.sh

    When you source a infohub_profile.sh, it displays the commands to set up a default InfoHub environment (global directory and a default database) if none exists.

  4. Execute the following command to load the server1.conf configuration file (discussed later in this document)

    $ $gtm_dist/mumps -run InfoHub --action=configure --file=$ihsrcdir/configs/server1.conf

  5. Execute the following command to start an InfoHub:

    $ $gtm_dist/mumps -run InfoHub --action=start

  6. Execute the following command to display the status of InfoHub with process listing:

    $ $gtm_dist/mumps -run InfoHub --action=full

  7. Execute the following command to shutdown an InfoHub:

    $ $gtm_dist/mumps -run InfoHub --action=shutdown

  8. Execute the following command to rundown an InfoHub:

    $ $gtm_dist/mumps -run InfoHub --action=rundown

To perform any InfoHub operation without using the infohub_*.sh scripts, at a bare minimum, you need to set the following environment variables:

If you are not using the InfoHub environment setup scripts provided with your InfoHub distribution, set the minimum key and record sizes to 1000 and 4000 respectively and block size to 4096 for the global directory for your InfoHub database. The InfoHub Bourne shell Environment setup scripts run a GDE command file to automatically set these values for the InfoHub global directory.

For more information on performing InfoHub operations, refer to Starting an InfoHub, Monitoring (checking) an InfoHub, Restarting an InfoHub, Shutting down an InfoHub, Rundown an InfoHub, Troubleshooting (debugging) an InfoHub, and Purging an InfoHub.

The following table describes some files in your InfoHub distribution. Note that InfoHub Product Routines files are part of the core InfoHub product and the Reference Implementations files are examples using InfoHub. The Uptime and Log File Monitoring Reference Implementation (ULFM) is one of the ready-to-run implementations that monitors the output of the uptime command, operator log, and authentication log requiring any additional configuration.

InfoHub Product Routines

IHsnmp.m

Implements the InfoHub SNMP Adaptor that performs all SNMP Plugin operations.

InfoHub.m

Implements the InfoHub API for all InfoHub operations.

InfoHubActionHandler.m

Implements orderly execution of InfoHub actions.

InfoHubConfigure.m

Validates and loads an InfoHub Configuration File.

InfoHubCfgExtract.m

Implements extraction and listing of configuration files.

InfoHubCli.m

Implements parsing of InfoHub command syntax to invoke InfoHub actions actions.

InfoHubCliParser.m

Used by the InfoHub routine to parse the command line options.

InfoHubDBSetup.m

Routine that creates a temporary database environment (mumps.gld and mumps.dat) for each Publisher; if necessary, removes the existing temporary database.

InfoHubError.m

Implements the InfoHub's Error handler.

InfoHubErrorMessage.m

The collection of InfoHub Error messages with severity codes.

InfoHubFileLine.m

Implements the FileLine job.

InfoHubJobs.m

Used by the InfoHub routine to JOB a process and to obtain its status.

InfoHubMain.m

Implements the main InfoHub job.

InfoHubNoInfo.m

Implements the Subscription that detects no change of a configured value within a configured period.

InfoHubNotify.m

Implements basic InfoHub subscription triggers

InfoHubPublisher.m

Implements the Publisher job.

InfoHubPurge.m

Implements time-based removal of data from the InfoHub globals.

InfoHubPipeLine.m

Implements the PipeLine process.

InfoHubProcessMonitor.m

Implements detection of process failure and restart.

InfoHubUtils.m

Common utility routines for InfoHub.

InfoHubVersion.m

The file with the current version of the InfoHub. The version is taken from the release date in the form of $HOROLOG where an underscore replaces the comma.

ULFM Reference Implementation files

LogFileGleaner.m

A simple gleaner routine that prepends each line read with a key, 9999. The format of result is <key>:<line_read_value>.

UptimeGleaner.m

A gleaner program that processes the output of the uptime command. It separates the uptime command fields into the key value pairs

SimpleMonitor.conf

The InfoHub configuration file used to configure the ULFM Reference Implementation.

PrevA UpA Next
A HomeA