blob: 5426c38145c360cc03366730df1212f1d7b9e509 (
plain)
| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 | 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.
 |