Statistics
| Branch: | Tag: | Revision:

root / man / ganeti-confd.sgml @ d729e03a

History | View | Annotate | Download (3.2 kB)

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