code.grnet.gr Git - ganeti-local/blob - 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 08, 2010</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       <year>2008</year>
  23       <year>2009</year>
  24       <year>2010</year>
  25       <holder>Google Inc.</holder>
  26     </copyright>
  27     &dhdate;
  28   </refentryinfo>
  29   <refmeta>
  30     &dhucpackage;
  31
  32     &dhsection;
  33     <refmiscinfo>Ganeti 2.2</refmiscinfo>
  34   </refmeta>
  35   <refnamediv>
  36     <refname>&dhpackage;</refname>
  37
  38     <refpurpose>Ganeti cluster watcher</refpurpose>
  39   </refnamediv>
  40   <refsynopsisdiv>
  41     <cmdsynopsis>
  42       <command>&dhpackage; </command>
  43
  44     </cmdsynopsis>
  45   </refsynopsisdiv>
  46   <refsect1>
  47     <title>DESCRIPTION</title>
  48
  49     <para>
  50       The <command>&dhpackage;</command> is a periodically run script
  51       which is responsible for keeping the instances in the correct
  52       status. It has two separate functions, one for the master node
  53       and another one that runs on every node.
  54     </para>
  55
  56     <refsect2>
  57       <title>Master operations</title>
  58
  59       <para>
  60         Its primary function is to try to keep running all instances
  61         which are marked as <emphasis>up</emphasis> in the configuration
  62         file, by trying to start them a limited number of times.
  63       </para>
  64
  65       <para>
  66         Its other function is to <quote>repair</quote> DRBD links by
  67         reactivating the block devices of instances which have
  68         secondaries on nodes that have been rebooted.
  69       </para>
  70
  71     </refsect2>
  72
  73     <refsect2>
  74
  75       <title>Node operations</title>
  76
  77       <para>
  78         The watcher will restart any down daemons that are appropriate
  79         for the current node.
  80       </para>
  81
  82       <para>
  83         In addition, it will execute any scripts which exist under the
  84         <quote>watcher</quote> directory in the Ganeti hooks directory
  85         (@SYSCONFDIR@/ganeti/hooks). This should be used for
  86         lightweight actions, like starting any extra daemons.
  87       </para>
  88
  89       <para>
  90         If the cluster
  91         parameter <literal>maintain_node_health</literal> is enabled,
  92         then the watcher will also shutdown instances and DRBD devices
  93         if the node is declared as offline by known master candidates.
  94       </para>
  95
  96       <para>
  97         The watcher does synchronous queries but will submit jobs for
  98         executing the changes. Due to locking, it could be that the jobs
  99         execute much later than the watcher executes them.
 100       </para>
 101
 102     </refsect2>
 103
 104
 105   </refsect1>
 106
 107   <refsect1>
 108     <title>FILES</title>
 109
 110     <para>
 111       The command has a state file located at
 112       <filename>@LOCALSTATEDIR@/lib/ganeti/watcher.data</filename>
 113       (only used on the master) and a log file at
 114       <filename>@LOCALSTATEDIR@/log/ganeti/watcher.log</filename>. Removal of
 115       either file will not affect correct operation; the removal of
 116       the state file will just cause the restart counters for the
 117       instances to reset to zero.
 118     </para>
 119
 120   </refsect1>
 121
 122   &footer;
 123
 124 </refentry>
 125
 126 <!-- Keep this comment at the end of the file
 127 Local variables:
 128 mode: sgml
 129 sgml-omittag:t
 130 sgml-shorttag:t
 131 sgml-minimize-attributes:nil
 132 sgml-always-quote-attributes:t
 133 sgml-indent-step:2
 134 sgml-indent-data:t
 135 sgml-parent-document:nil
 136 sgml-default-dtd-file:nil
 137 sgml-exposed-tags:nil
 138 sgml-local-catalogs:nil
 139 sgml-local-ecat-files:nil
 140 End:
 141 -->