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

   1 ganeti-confd(8) Ganeti | Version @GANETI_VERSION@
   2 =================================================
   3
   4 Name
   5 ----
   6
   7 ganeti-confd - Ganeti conf daemon
   8
   9 Synopsis
  10 --------
  11
  12 **ganeti-confd** [-f] [-d]
  13
  14 DESCRIPTION
  15 -----------
  16
  17 **ganeti-confd** is a daemon used to answer queries related to the
  18 configuration of a Ganeti cluster.
  19
  20 For testing purposes, you can give the ``-f`` option and the
  21 program won't detach from the running terminal.
  22
  23 Debug-level message can be activated by giving the ``-d`` option.
  24
  25 Logging to syslog, rather than its own log file, can be enabled by
  26 passing in the ``--syslog`` option.
  27
  28 The **ganeti-confd** daemon listens to port 1814 UDP, on all interfaces,
  29 by default. The port can be overridden by an entry the services database
  30 (usually ``/etc/services``) or by passing the ``-p`` option.  The ``-b``
  31 option can be used to specify the address to bind to (defaults to
  32 ``0.0.0.0``).
  33
  34 The daemon will refuse to start if the user and group do not match the
  35 one defined at build time; this behaviour can be overridden by the
  36 ``--no-user-checks`` option.
  37
  38 ROLE
  39 ~~~~
  40
  41 The role of the conf daemon is to make sure we have a highly available
  42 and very fast way to query cluster configuration values.  This daemon
  43 is automatically active on all master candidates, and so has no single
  44 point of failure. It communicates via UDP so each query can easily be
  45 sent to multiple servers, and it answers queries from a cached copy of
  46 the config it keeps in memory, so no disk access is required to get an
  47 answer.
  48
  49 The config is reloaded from disk automatically when it changes, with a
  50 rate limit of once per second.
  51
  52 If the conf daemon is stopped on all nodes, its clients won't be able
  53 to get query answers.
  54
  55 COMMUNICATION PROTOCOL
  56 ~~~~~~~~~~~~~~~~~~~~~~
  57
  58 The confd protocol is an HMAC authenticated json-encoded custom
  59 format, over UDP. A client library is provided to make it easy to
  60 write software to query confd. More information can be found in the
  61 Ganeti 2.1 design doc, and an example usage can be seen in the
  62 (external) NBMA daemon for Ganeti.
  63
  64 .. vim: set textwidth=72 :
  65 .. Local Variables:
  66 .. mode: rst
  67 .. fill-column: 72
  68 .. End: