Skip to content

Commit

Permalink
Improve Getting Started by basic information
Browse files Browse the repository at this point in the history
  • Loading branch information
Krysztophe authored and rjuju committed Apr 9, 2018
1 parent c7d5727 commit 332af9e
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
27 changes: 27 additions & 0 deletions general/getting_started.rst
@@ -1,2 +1,29 @@
Getting started
===============

Overview
--------

OPM is a set of tools working above Nagios (or similar)
to store into a database the perfdata retrieved by any Nagios agent
and graph them in a web dashboard.

check_pgactivity (https://github.com/OPMDG/check_pgactivity) is a Nagios agent
dedicated to PostgreSQL.
It is technically separated from OPM.


Requirements & Installation
---------------------------

We suppose that you have in place and configured to your need:
* a working Nagios (or similar) installation
* agents displaying perfdata (e.g. check_pgactivity or other Nagios probes)
* an empty PostgreSQL database (9.3 or later) on the instance of your choice
to store the data.

See the :doc:`Installation <../opm-core/Installation>` page to install:
* the :ref:`opm_core <opm_core>` and :ref:`wh_nagios <wh_nagios>` extensions
* the :ref:`nagios dispatcher script<nagios_and_nagios_dispatcher>` to
retrieve the perfdata
* the :ref:`web user interface <user_interface>`.
4 changes: 4 additions & 0 deletions opm-core/Installation.rst
Expand Up @@ -14,6 +14,8 @@ The tool ``pg_config`` is required. Distributions packages put it usually in ``/

We suppose that the repositories **opm-core** (https://github.com/OPMDG/opm-core) and **opm-wh_nagios** (https://github.com/OPMDG/opm-wh_nagios) are stored into **/usr/local/src/opm/** (your OPM directory).

.. _opm_core:

OPM core
--------

Expand Down Expand Up @@ -253,6 +255,8 @@ and start the job::

root:~# initctl start nagios_dispatcher

.. _user_interface:

User interface
--------------

Expand Down

0 comments on commit 332af9e

Please sign in to comment.