Source:
    https://projects.bytemark.co.uk/projects/custodian

Copyright:
    Copyright (c) 2012 Bytemark Computer Consulting Ltd

Licence:
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.




About Custodian
---------------

Custodian is a simple, scalable, and reliable protocol-tester that allows
a number of services to be tested across a network.

The core design is based upon a work queue, which is manipulated by two
main scripts:

  custodian-enqueue
    * A parser that reads a list of hosts and tests to apply.  These
      tests are broken down into individual jobs, serialized and stored
      in a central queue.

  custodian-dequeue
    * A tool that pulls jobs from the queue, executing them in turn, and
      raises/clears alerts based upon the result of the test.




Configuration
-------------

The software is configured by a single main configuration file located at:

   /etc/custodian/custodian.cfg

This file contains the alerting mechanism to use, the IP:port of the queue
the two scripts mentioned above use, and similar static things.

Each of the available configuration options has a sensible default which
is documented in that same file.




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

The software is documented online at the project home-page:

    https://projects.bytemark.co.uk/projects/custodian/wiki

Beyond that each script has a manpage which is installed when the
package is installed - or which may be examined by invoking the
script with the "--manual" flag.