Commit e9ba0663 authored by Thomas Thrainer's avatar Thomas Thrainer

Document ganeti-queryd

Add a man page for ganeti-queryd and update the documentation for
ganeti-confd in various places.
Signed-off-by: default avatarThomas Thrainer <thomasth@google.com>
Reviewed-by: default avatarHelga Velroyen <helgav@google.com>
parent 135eb4ee
......@@ -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
......
......@@ -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 \
......
......@@ -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
......
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:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment