code.grnet.gr Git - ganeti-local/blob - man/ganeti-confd.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3   <!-- Please adjust the date whenever revising the manpage. -->
   4   <!ENTITY dhdate      "<date>June 08, 2010</date>">
   5   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
   6        allowed: see man(7), man(1). -->
   7   <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
   8   <!ENTITY dhucpackage "<refentrytitle>ganeti-confd</refentrytitle>">
   9   <!ENTITY dhpackage   "ganeti-confd">
  10
  11   <!ENTITY debian      "<productname>Debian</productname>">
  12   <!ENTITY gnu         "<acronym>GNU</acronym>">
  13   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  14   <!ENTITY footer SYSTEM "footer.sgml">
  15 ]>
  16
  17 <refentry>
  18   <refentryinfo>
  19     <copyright>
  20       <year>2009</year>
  21       <holder>Google Inc.</holder>
  22     </copyright>
  23     &dhdate;
  24   </refentryinfo>
  25   <refmeta>
  26     &dhucpackage;
  27
  28     &dhsection;
  29     <refmiscinfo>Ganeti 2.2</refmiscinfo>
  30   </refmeta>
  31   <refnamediv>
  32     <refname>&dhpackage;</refname>
  33
  34     <refpurpose>Ganeti conf daemon</refpurpose>
  35   </refnamediv>
  36   <refsynopsisdiv>
  37     <cmdsynopsis>
  38       <command>&dhpackage; </command>
  39       <arg>-f</arg>
  40       <arg>-d</arg>
  41
  42     </cmdsynopsis>
  43   </refsynopsisdiv>
  44   <refsect1>
  45     <title>DESCRIPTION</title>
  46
  47     <para>
  48       <command>&dhpackage;</command> is a daemon used to answer queries related
  49       to the configuration of a Ganeti cluster.
  50     </para>
  51
  52     <para>
  53       For testing purposes, you can give the <option>-f</option>
  54       option and the program won't detach from the running terminal.
  55     </para>
  56
  57     <para>
  58       Debug-level message can be activated by giving the
  59       <option>-d</option> option.
  60     </para>
  61     <refsect2>
  62       <title>ROLE</title>
  63       <para>
  64         The role of the conf daemon is to make sure we have a highly available
  65         and very fast way to query cluster configuration values. This daemon is
  66         automatically active on all master candidates, and so has no single
  67         point of failure. It communicates via UDP so each query can easily be
  68         sent to multiple servers, and it answers queries from a cached copy of
  69         the config it keeps in memory, so no disk access is required to get an
  70         answer.
  71       </para>
  72
  73       <para>
  74         The config is reloaded from disk automatically when it changes, with a
  75         rate limit of once per second.
  76       </para>
  77
  78       <para>
  79         If the conf daemon is stopped on all nodes, its clients won't be able
  80         to get query answers.
  81       </para>
  82     </refsect2>
  83
  84     <refsect2>
  85       <title>COMMUNICATION PROTOCOL</title>
  86       <para>
  87         The confd protocol is an HMAC authenticated json-encoded custom format,
  88         over UDP. A client library is provided to make it easy to write
  89         software to query confd. More information can be found in the Ganeti
  90         2.1 design doc, and an example usage can be seen in the (external) NBMA
  91         daemon for Ganeti.
  92       </para>
  93     </refsect2>
  94
  95   </refsect1>
  96
  97   &footer;
  98
  99 </refentry>
 100
 101 <!-- Keep this comment at the end of the file
 102 Local variables:
 103 mode: sgml
 104 sgml-omittag:t
 105 sgml-shorttag:t
 106 sgml-minimize-attributes:nil
 107 sgml-always-quote-attributes:t
 108 sgml-indent-step:2
 109 sgml-indent-data:t
 110 sgml-parent-document:nil
 111 sgml-default-dtd-file:nil
 112 sgml-exposed-tags:nil
 113 sgml-local-catalogs:nil
 114 sgml-local-ecat-files:nil
 115 End:
 116 -->