1SIMPLEVISOR(1)               simplevisor man page               SIMPLEVISOR(1)
2
3
4

NAME

6       simplevisor 1.2 - simple daemons supervisor
7

SYNOPSIS

9       simplevisor [--conf CONF][--conftype CONFTYPE][--daemon][--interval
10       INTERVAL][-h][--log LOG][--logfile LOGFILE][--loglevel
11       LOGLEVEL][--logname LOGNAME][-p PIDFILE][--store STORE][--version]
12       command [path]
13

DESCRIPTION

15       Simplevisor is a simple daemons supervisor, it is inspired by Erlang
16       OTP and it can supervise hierarchies of services.
17
18       COMMANDS
19
20       If a path is given or only one service entry is given:
21
22       for a given X command
23           run the service X command where service is the only entry provided
24           or the entry identified by its path
25
26       If a path is given and the root entry is a supervisor:
27
28       restart_child
29           tell a running simplevisor process to restart the child identified
30           by the given path; it is different from the restart command as
31           described above because, this way, we are sure that the running
32           simplevisor will not attempt to check/start/stop the child while
33           we restart it
34
35       If a path is not given and the root entry is a supervisor:
36
37       start
38           start the simplevisor process which start the supervision.
39           It can be used with --daemon if you want it as daemon
40
41       stop
42           stop the simplevisor process and all its children, if running
43
44       status
45           return the status of the simplevisor process
46
47       check
48           return the comparison between the expected state and the actual
49       state.
50           0 -> everything is fine
51           1 -> warning, not expected
52
53       single
54           execute one cycle of supervision and exit.
55           Useful to be run in a cron script
56
57       wake_up
58           tell a running simplevisor process to wake up and supervise
59
60       stop_supervisor
61           only stop the simplevisor process but not the children
62
63       stop_children
64           only stop the children but not the simplevisor process
65
66       check_configuration
67           only check the configuration file
68
69       pod
70           generate pod format help to be used by pod2man to generate man page
71
72       rst
73           generate rst format help to be used in the web doc
74
75       help
76           same as -h/--help, print help page
77

OPTIONS

79       positional arguments:
80
81           command check, check_configuration, help, pod, restart,
82           restart_child, rst, single, start, status, stop, stop_children,
83           stop_supervisor, wake_up
84
85           path path to a service, subset of commands available: start, stop,
86           status, check, restart
87
88       optional arguments:
89
90           --conf CONF configuration file
91
92           --conftype CONFTYPE configuration file type (default: apache)
93
94           --daemon daemonize, ONLY with start
95
96           --interval INTERVAL interval to wait between supervision cycles
97           (default: 60)
98
99           -h, --help print the help page
100
101           --log LOG available: null, file, syslog, stdout (default: stdout)
102
103           --logfile LOGFILE log file, ONLY for file
104
105           --loglevel LOGLEVEL log level (default: warning)
106
107           --logname LOGNAME log name (default: simplevisor)
108
109           -p, --pidfile PIDFILE the pidfile
110
111           --store STORE file where to store the state, it is not mandatory,
112           however recommended to store the simplevisor nodes status between
113           restarts
114
115           --version print the program version
116

EXAMPLES

118       Create and edit the main configuration file:
119
120           ## look for simplevisor.conf.example in the examples.
121
122       Run it:
123
124           simplevisor --conf /path/to/simplevisor.conf start
125
126       to run it in daemon mode:
127
128           simplevisor --conf /path/to/simplevisor.conf --daemon start
129
130       For other commands:
131
132           simplevisor --help
133
134       Given the example configuration, to start the httpd service:
135
136           simplevisor --conf /path/to/simplevisor.conf start svisor1/httpd
137

AUTHOR

139       Massimo Paladin <massimo.paladin@gmail.com>
140
141       Copyright (C) CERN 2013-2016
142
143
144
145                                  2016-06-27                    SIMPLEVISOR(1)