Metadata-Version: 2.1
Name: alignak-checks-alignak
Version: 1.1.0
Summary: Alignak checks pack for Alignak daemons
Home-page: https://github.com/Alignak-monitoring-contrib/alignak-checks-linux-nrpe
Author: Frédéric MOHIER
Author-email: frederic.mohier@alignak.net
License: GNU Affero General Public License, version 3
Keywords: a,l,i,g,n,a,k, ,m,o,n,i,t,o,r,i,n,g, ,p,a,c,k, ,c,h,e,c,k,s, ,a,l,i,g,n,a,k
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
Requires-Dist: requests

Alignak checks package for Alignak daemons
==========================================

*Checks pack for monitoring Alignak daemons with the Nagios monitoring check_tcp*


.. image:: https://badge.fury.io/py/alignak_checks_alignak.svg
    :target: https://badge.fury.io/py/alignak-checks-alignak
    :alt: Most recent PyPi version

.. image:: https://img.shields.io/badge/IRC-%23alignak-1e72ff.svg?style=flat
    :target: http://webchat.freenode.net/?channels=%23alignak
    :alt: Join the chat #alignak on freenode.net

.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
    :target: http://www.gnu.org/licenses/agpl-3.0
    :alt: License AGPL v3


**Note:** *this check pack is only an example for checking Alignak daemons using the Nagios check_tcp command. Please feel free to comment or suggest improvements :)*


Installation
------------

The installation of this checks pack will copy some configuration files in the Alignak default configuration directory (eg. */usr/local/share/alignak/etc*). The copied files are located in the default sub-directory used for the packs (eg. *arbiter/packs*).

From PyPI
~~~~~~~~~
To install the package from PyPI:
::

   sudo pip install alignak-checks-alignak


From source files
~~~~~~~~~~~~~~~~~
To install the package from the source files:
::

   git clone https://github.com/Alignak-monitoring-contrib/alignak-checks-alignak
   cd alignak-checks-alignak
   sudo pip install .

**Note:** *using `sudo python setup.py install` will not correctly manage the package configuration files! The recommended way is really to use `pip`;)*

Documentation
-------------

Configuration
~~~~~~~~~~~~~

This checks pack is using the `check_http` Nagios (or Monitoring) plugin that must be installed on the Alignak server running your poller daemon. You may install the common Nagios plugins or the `alignak-checks-monitoring` package (see the `corresponding repo <https://github.com/alignak-monitoring-contrib/alignak-checks-monitoring>`_).

It is also checking information directly from the Algnak arbiter API endpoints thanks to an embedded script.



Alignak configuration
~~~~~~~~~~~~~~~~~~~~~

For a standard Alignak host, you simply have to tag the concerned host with the template ``alignak``.::

   # An host with all the Alignak daemons
   define host{
      use                     alignak
      host_name               my_alignak
      address                 127.0.0.1
   }


For a specific configuration, set the ` _satellites` host variable with the list of your configured daemons::

   # An host with some specific Alignak daemons
   define host{
      use                     alignak
      host_name               my_alignak
      address                 127.0.0.1

      # Default satellites is one instance of each type
      # Service generator variable:
      # - $(type)
      # - $(unique name)
      # - $(port)
      _satellites       arbiter-master$(arbiter)$$(arbiter-master)$$(10000)$,\
                        scheduler-master$(scheduler)$$(scheduler-master)$$(10001)$,\
                        scheduler-second$(scheduler)$$(scheduler-second)$$(20001)$,\
                        scheduler-third$(scheduler)$$(scheduler-third)$$(30001)$,\
                        reactionner-master$(reactionner)$$(reactionner-master)$$(10002)$,\
                        poller-master$(poller)$$(poller-master)$$(10003)$,\
                        broker-master$(broker)$$(broker-master)$$(10004)$,\
                        receiver-master$(receiver)$$(receiver-master)$$(1005)$

      _ALIGNAK_ENDPOINT   http://127.0.0.1:10000
   }


When using the alignak backend, use the `setup.sh` script provided in the *json/elasticsearch* directory to include all the package information into your backend
::

    # Backend configuration
    $ json/alignak/setup.sh -b http://127.0.0.1:5000 -u admin -p admin


**Note** that this command line is executed when installing the package from *pip*. If your backend is not set locally, you can specify its address thanks to the `-b` command line parameter.



Bugs, issues and contributing
-----------------------------

Contributions to this project are welcome and encouraged ... `issues in the project repository <https://github.com/alignak-monitoring-contrib/alignak-checks-alignak/issues>`_ are the common way to raise an information.


