ctdb-doc: document nodes list configuration parameter

Add the initial documentation of the node list configuration parameter.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
Reviewed-by: Martin Schwenke <martin@meltin.net>
Autobuild-User(master): Martin Schwenke <martins@samba.org>
Autobuild-Date(master): Tue Aug  6 01:50:12 UTC 2024 on atb-devel-224

diff --git a/ctdb/doc/ctdb.7.xml b/ctdb/doc/ctdb.7.xml
index 0f3fbc6bf6ac776094b8654cf6025ce59dbe99ea..be2dd5e5b65c3cdacfc7d3a8c7575f936bb9878d 100644 (file)
--- a/ctdb/doc/ctdb.7.xml
+++ b/ctdb/doc/ctdb.7.xml
@@ -233,8 +233,8 @@
 
       <para>
        Some users like to put this configuration file in their
-       cluster filesystem.  A symbolic link should be used in this
-       case.
+       cluster filesystem.  A symbolic link or the
+       <parameter>nodes list</parameter> parameter can be used.
       </para>
 
       <para>

diff --git a/ctdb/doc/ctdb.conf.5.xml b/ctdb/doc/ctdb.conf.5.xml
index b9bf3a6d08b928c16e0e94996d23516fa98136ac..615a61e5bfed0b8ba587bf7b88d126dd81753ad7 100644 (file)
--- a/ctdb/doc/ctdb.conf.5.xml
+++ b/ctdb/doc/ctdb.conf.5.xml
@@ -255,6 +255,46 @@
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term>nodes list = <parameter>SOURCE</parameter></term>
+       <listitem>
+         <para>
+           SOURCE specifies the location containing the list of the private
+           addresses of nodes in the cluster.
+         </para>
+         <para>
+           Typically, SOURCE will be a path to a file that contains the list of
+           private addresses for the cluster.
+           For details about the content of the file please see the
+           <citetitle>PRIVATE ADDRESSES</citetitle> section in
+           <citerefentry><refentrytitle>ctdb</refentrytitle>
+           <manvolnum>7</manvolnum></citerefentry>.
+         </para>
+         <para>
+           As an alternative to using a file one can use an arbitrary command
+           to provide the contents of the nodes list. If an exclamation point ('!')
+           is the first character of the SOURCE value, the remainder of the value
+           will be executed when the private addresses are to be read.
+           For example, a value of <command>!/usr/local/bin/mynodes cluster1</command>
+           would run the given command with the specified arguments. The output
+           generated by the command (on standard out) must be the same as what is
+           supported by a SOURCE file.
+           The command name must be a full path to an executable. Arguments are
+           supported, but shell-style quoting is not, and space characters will
+           always produce a new argument for the command.
+           It is important to note that running this command blocks until
+           the command has completed. The run time of this command will depend
+           on how it is implemented and environmental factors. Be aware that if
+           the command runs for a non-trivial amount of time it can introduce
+           undesirable stalls into ctdbd.
+         </para>
+         <para>
+           Default:
+           <filename>/usr/local/etc/ctdb/nodes</filename>
+         </para>
+       </listitem>
+      </varlistentry>
+
       <varlistentry>
        <term>transport = tcp|ib</term>
        <listitem>