Document ganeti-queryd
authorThomas Thrainer <thomasth@google.com>
Tue, 16 Jul 2013 07:34:57 +0000 (09:34 +0200)
committerThomas Thrainer <thomasth@google.com>
Wed, 17 Jul 2013 09:33:53 +0000 (11:33 +0200)
Add a man page for ganeti-queryd and update the documentation for
ganeti-confd in various places.

Signed-off-by: Thomas Thrainer <thomasth@google.com>
Reviewed-by: Helga Velroyen <helgav@google.com>

INSTALL
Makefile.am
man/ganeti-confd.rst
man/ganeti-queryd.rst [new file with mode: 0644]

diff --git a/INSTALL b/INSTALL
index e9d7ab5..850cffd 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -177,8 +177,8 @@ Haskell optional features
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Optionally, more functionality can be enabled if your build machine has
-a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
-(``--enable-confd``) and the monitoring daemon
+a few more Haskell libraries enabled: the ``ganeti-confd`` and
+``ganeti-queryd`` daemon (``--enable-confd``) and the monitoring daemon
 (``--enable-mond``). The list of extra dependencies for these is:
 
 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
index ec797c5..c8366d1 100644 (file)
@@ -986,6 +986,7 @@ EXTRA_DIST = \
 man_MANS = \
        man/ganeti-cleaner.8 \
        man/ganeti-confd.8 \
+       man/ganeti-queryd.8 \
        man/ganeti-listrunner.8 \
        man/ganeti-masterd.8 \
        man/ganeti-mond.8 \
index 09b0934..0bf6ed6 100644 (file)
@@ -29,11 +29,7 @@ The **ganeti-confd** daemon listens to port 1814 UDP, on all interfaces,
 by default. The port can be overridden by an entry the services database
 (usually ``/etc/services``) or by passing the ``-p`` option.  The ``-b``
 option can be used to specify the address to bind to (defaults to
-``0.0.0.0``). The daemon also listens on a Unix socket
-(``@LOCALSTATEDIR@/run/ganeti/socket/ganeti-query``) on which it exports
-a ``Luxi`` endpoint, serving query operations only. Commands and tools
-use this socket if the build-time option for split queries has been
-enabled.
+``0.0.0.0``).
 
 The daemon will refuse to start if the user and group do not match the
 one defined at build time; this behaviour can be overridden by the
diff --git a/man/ganeti-queryd.rst b/man/ganeti-queryd.rst
new file mode 100644 (file)
index 0000000..de185a0
--- /dev/null
@@ -0,0 +1,58 @@
+ganeti-queryd(8) Ganeti | Version @GANETI_VERSION@
+==================================================
+
+Name
+----
+
+ganeti-queryd - Ganeti query daemon
+
+Synopsis
+--------
+
+**ganeti-queryd** [-f] [-d]
+
+DESCRIPTION
+-----------
+
+**ganeti-queryd** is a daemon used to answer queries related to the
+configuration and the current live state of a Ganeti cluster.
+
+For testing purposes, you can give the ``-f`` option and the
+program won't detach from the running terminal.
+
+Debug-level message can be activated by giving the ``-d`` option.
+
+Logging to syslog, rather than its own log file, can be enabled by
+passing in the ``--syslog`` option.
+
+The **ganeti-queryd** daemon listens on a Unix socket
+(``@LOCALSTATEDIR@/run/ganeti/socket/ganeti-query``) on which it exports
+a ``Luxi`` endpoint, serving query operations only. Commands and tools
+use this socket if the build-time option for split queries has been
+enabled.
+
+The daemon will refuse to start if the user and group do not match the
+one defined at build time; this behaviour can be overridden by the
+``--no-user-checks`` option.
+
+ROLE
+~~~~
+
+The role of the query daemon is to answer queries about the (live)
+cluster state without going through the master daemon. Only queries
+which don't require locks can be handles by the query daemon, which
+might lead to slightly outdated results in some cases.
+
+The config is reloaded from disk automatically when it changes, with a
+rate limit of once per second.
+
+COMMUNICATION PROTOCOL
+~~~~~~~~~~~~~~~~~~~~~~
+
+See **gnt-master**\(8).
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: