Add a man page for ganeti-wconfd
authorKlaus Aehlig <aehlig@google.com>
Mon, 22 Jun 2015 15:50:43 +0000 (17:50 +0200)
committerKlaus Aehlig <aehlig@google.com>
Tue, 23 Jun 2015 09:10:07 +0000 (11:10 +0200)
This daemon was added with the jobs-as-processes refactoring,
but a man page has not been added so far. Do this now.

Signed-off-by: Klaus Aehlig <aehlig@google.com>
Reviewed-by: Petr Pudlak <pudlak@google.com>

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

index c9fd066..8ccb352 100644 (file)
@@ -1501,6 +1501,7 @@ man_MANS = \
        man/ganeti-extstorage-interface.7 \
        man/ganeti-rapi.8 \
        man/ganeti-watcher.8 \
+       man/ganeti-wconfd.8 \
        man/ganeti.7 \
        man/gnt-backup.8 \
        man/gnt-cluster.8 \
diff --git a/man/ganeti-wconfd.rst b/man/ganeti-wconfd.rst
new file mode 100644 (file)
index 0000000..bb01503
--- /dev/null
@@ -0,0 +1,48 @@
+ganeti-wconfd(8) Ganeti | Version @GANETI_VERSION@
+==================================================
+
+Name
+----
+
+ganeti-wconfd - Ganeti configuration writing daemon
+
+Synopsis
+--------
+
+**ganeti-wcond** [-f] [-d] [--syslog] [--no-user-checks]
+[--no-voting --yes-do-it] [--force-node]
+
+DESCRIPTION
+-----------
+
+**ganeti-wconfd** is the daemon that has authoritative knowledge
+about the configuration and is the only entity that can accept
+changes to it. All jobs that need to modify the configuration will
+do so by sending appropriate requests to this daemon.
+
+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-wconfd** daemon listens on a Unix socket
+(``@LOCALSTATEDIR@/run/ganeti/socket/ganeti-query``) on which it accepts all
+requests in an internal protocol format, used by Ganeti jobs.
+
+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.
+
+The daemon will refuse to start if it cannot verify that the majority
+of cluster nodes believes that it is running on the master node. To
+allow failover in a two-node cluster, this can be overridden by the
+``--no-voting`` option. As it this is dangerous, the ``--yes-do-it``
+option has to be given as well. Also, if the option ``--force-node``
+is given, it will accept to run on a non-master node; it should not
+be necessary to give this option manually, but
+``gnt-cluster masterfailover`` will use it internally to start
+the daemon in order to update the master-node information in the
+configuration.