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

Revision 8cc002c0df9ed5ecbe6c0eb143a05f84be72b354, 1.9 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
35The configuration file is documented here: L<XAS::Apps::Supervisor::Monitor|XAS::Apps::Supervisor::Monitor>
36
37=head2 xas-supctl
38
39This is a command line tool to communicate with the supervisor. With this
40tool you can stop, start, pause, resume or kill a managed process. You
41can also retrieve all of the processes that the supervisor knows about and
42you can check the status of individual processes.
43
44=head1 SEE ALSO
45
46=over 4
47
48=item L<XAS::Apps::Supervisor::Client|XAS::Apps::Supervisor::Client>
49
50=item L<XAS::Apps::Supervisor::Monitor|XAS::Apps::Supervisor::Monitor>
51
52=item L<XAS::Docs::Supervisor::Installation|XAS::Docs::Supervisor::Installation>
53
54=item L<XAS::Supervisor::Client|XAS::Supervisor::Client>
55
56=item L<XAS::Supervisor::Controller|XAS::Supervisor::Controller>
57
58=item L<XAS::Supervisor::Monitor|XAS::Supervisor::Monitor>
59
60=item L<XAS|XAS>
61
62=back
63
64=head1 AUTHOR
65
66Kevin L. Esteb, E<lt>kevin@kesteb.usE<gt>
67
68=head1 LICENSE AND COPYRIGHT
69
70Copyright (c) 2012-2015 Kevin L. Esteb
71
72This is free software; you can redistribute it and/or modify it under
73the terms of the Artistic License 2.0. For details, see the full text
74of the license at http://www.perlfoundation.org/artistic_license_2_0.
75
76=cut
Note: See TracBrowser for help on using the repository browser.