Fix some pylint-detected issues
[ganeti-local] / man / ganeti-watcher.sgml
1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4   <!-- Please adjust the date whenever revising the manpage. -->
5   <!ENTITY dhdate      "<date>June 20, 2007</date>">
6   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
7        allowed: see man(7), man(1). -->
8   <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
9   <!ENTITY dhucpackage "<refentrytitle>ganeti-watcher</refentrytitle>">
10   <!ENTITY dhpackage   "ganeti-watcher">
11
12   <!ENTITY debian      "<productname>Debian</productname>">
13   <!ENTITY gnu         "<acronym>GNU</acronym>">
14   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
15   <!ENTITY footer SYSTEM "footer.sgml">
16 ]>
17
18 <refentry>
19   <refentryinfo>
20     <copyright>
21       <year>2007</year>
22       <holder>Google Inc.</holder>
23     </copyright>
24     &dhdate;
25   </refentryinfo>
26   <refmeta>
27     &dhucpackage;
28
29     &dhsection;
30     <refmiscinfo>ganeti 1.2</refmiscinfo>
31   </refmeta>
32   <refnamediv>
33     <refname>&dhpackage;</refname>
34
35     <refpurpose>ganeti cluster watcher</refpurpose>
36   </refnamediv>
37   <refsynopsisdiv>
38     <cmdsynopsis>
39       <command>&dhpackage; </command>
40
41     </cmdsynopsis>
42   </refsynopsisdiv>
43   <refsect1>
44     <title>DESCRIPTION</title>
45
46     <para>
47       The <command>&dhpackage;</command> is a periodically run script
48       which is responsible for keeping the instances in the correct
49       status.
50     </para>
51
52     <para>
53       Its primary function is to try to keep running all instances
54       which are marked as <emphasis>up</emphasis> in the configuration
55       file, by trying to start them a limited number of times.
56     </para>
57
58     <para>
59       Its other function is to <quote>repair</quote> DRBD links by
60       reactivating the block devices of instances which have
61       secondaries on nodes that have been rebooted.
62     </para>
63
64     <para>In order to prevent piling up commands, all the
65     <emphasis>gnt-*</emphasis> commands executed by ganeti-watcher are
66     run with a timeout of 15 seconds.
67     </para>
68
69     <para>
70       The command has a state file located at
71       <filename>@LOCALSTATEDIR@/lib/ganeti/watcher.data</filename> and a log
72       file at
73       <filename>@LOCALSTATEDIR@/log/ganeti/watcher.log</filename>. Removal of
74       either file will not affect correct operation; the removal of
75       the state file will just cause the restart counters for the
76       instances to reset to zero.
77     </para>
78
79   </refsect1>
80
81   &footer;
82
83 </refentry>
84
85 <!-- Keep this comment at the end of the file
86 Local variables:
87 mode: sgml
88 sgml-omittag:t
89 sgml-shorttag:t
90 sgml-minimize-attributes:nil
91 sgml-always-quote-attributes:t
92 sgml-indent-step:2
93 sgml-indent-data:t
94 sgml-parent-document:nil
95 sgml-default-dtd-file:nil
96 sgml-exposed-tags:nil
97 sgml-local-catalogs:nil
98 sgml-local-ecat-files:nil
99 End:
100 -->