source: xas-supervisor/trunk/lib/XAS/Supervisor.pm @ abf00c1de58a791380cf569e01138e3f9a5af54c

Revision abf00c1de58a791380cf569e01138e3f9a5af54c, 2.3 KB checked in by Kevin L. Esteb <kevin@…>, 4 years ago (diff)

updating documentation

  • Property mode set to 100644
Line 
1package XAS::Supervisor;
2
3use strict;
4use warnings;
5
6our $VERSION = '0.01';
7
81;
9
10__END__
11 
12=head1 NAME
13
14XAS::Supervisor - A set of modules and procedures to supervise processes
15
16=head1 DESCRIPTION
17
18A supervisor is a process that manages other processes. On Unix this would be
19similar to init, which is the master process.
20
21=head1 UTILITIES
22
23These utilities are provided with this package.
24
25=head2 xas-supervisor
26
27This is the control process. It reads a configuration file to see what
28processes to start. Once they are started, the supervisor will make sure that
29they continue to run.
30
31When a process exits, the supervisor checks the exit status. If that status is
32known, it will restart the process otherwise it will send alert that the process
33has stopped.
34
35=over 4
36
37=item B<xas-supervisor --help>
38
39This will display a brief help screen on command options.
40
41=item B<xas-supervisor --manual>
42
43This will display the utilities man page.
44
45=back
46
47The configuration file is documented here: L<XAS::Apps::Supervisor::Monitor|XAS::Apps::Supervisor::Monitor>
48
49=head2 xas-supctl
50
51This is a command line tool to communicate with the supervisor. With this
52tool you can stop, start, pause, resume or kill a managed process. You
53can also retrieve all of the processes that the supervisor knows about and
54you can check the status of individual processes.
55
56=over 4
57
58=item B<xas-supctl --help>
59
60This will display a brief help screen on command options.
61
62=item B<xas-supctl --manual>
63
64This will display the utilities man page.
65
66=back
67
68=head1 SEE ALSO
69
70=over 4
71
72=item L<XAS::Apps::Supervisor::Client|XAS::Apps::Supervisor::Client>
73
74=item L<XAS::Apps::Supervisor::Monitor|XAS::Apps::Supervisor::Monitor>
75
76=item L<XAS::Docs::Supervisor::Installation|XAS::Docs::Supervisor::Installation>
77
78=item L<XAS::Supervisor::Client|XAS::Supervisor::Client>
79
80=item L<XAS::Supervisor::Controller|XAS::Supervisor::Controller>
81
82=item L<XAS::Supervisor::Monitor|XAS::Supervisor::Monitor>
83
84=item L<XAS|XAS>
85
86=back
87
88=head1 AUTHOR
89
90Kevin L. Esteb, E<lt>kevin@kesteb.usE<gt>
91
92=head1 LICENSE AND COPYRIGHT
93
94Copyright (c) 2012-2015 Kevin L. Esteb
95
96This is free software; you can redistribute it and/or modify it under
97the terms of the Artistic License 2.0. For details, see the full text
98of the license at http://www.perlfoundation.org/artistic_license_2_0.
99
100=cut
Note: See TracBrowser for help on using the repository browser.