ctdb-docs: Add ctdb.conf(5) cross references and documentation tweaks

Minor updates to other manual pages for compatibility.

Signed-off-by: Martin Schwenke <martin@meltin.net>
Reviewed-by: Amitay Isaacs <amitay@gmail.com>

diff --git a/ctdb/doc/ctdb-etcd.7.xml b/ctdb/doc/ctdb-etcd.7.xml
index 59acece321b487a89f6e19c81471a283836cd0ae..5d7a0e053662c16caca35a94e01a53aa426273db 100644 (file)
--- a/ctdb/doc/ctdb-etcd.7.xml
+++ b/ctdb/doc/ctdb-etcd.7.xml
@@ -62,11 +62,13 @@
       will try to connect to an existing etcd cluster and grab a lock in that
       cluster to function as CTDB's recovery lock. Please see
       <emphasis>ctdb/doc/cluster_mutex_helper.txt</emphasis> for details on
-      the mutex helper API. To use this, include the following line in your
-      CTDB config file:
+      the mutex helper API. To use this, include the following line in
+      the <literal>[cluster]</literal> section of
+      <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
+      <manvolnum>5</manvolnum></citerefentry>:
     </para>
     <screen format="linespecific">
-CTDB_RECOVERY_LOCK="!/usr/local/usr/libexec/ctdb/ctdb_etcd_lock"
+recovery lock = !/usr/local/usr/libexec/ctdb/ctdb_etcd_lock
     </screen>
     <para>
       You can also pass "-v", "-vv", or "-vvv" to include verbose output in

diff --git a/ctdb/doc/ctdb-script.options.5.xml b/ctdb/doc/ctdb-script.options.5.xml
index 22cdd371bd21a06d15ef0e8cb303a891224c28c5..ad7f352f5c73987c5e192da446a93b3217e435df 100644 (file)
--- a/ctdb/doc/ctdb-script.options.5.xml
+++ b/ctdb/doc/ctdb-script.options.5.xml
@@ -1057,10 +1057,11 @@ CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
 
            <para>
              Default is to warn for each filesystem containing a
-             database directory (<envar>CTDB_DBDIR</envar>,
-             <envar>CTDB_DBDIR_PERSISTENT</envar>,
-             <envar>CTDB_DBDIR_STATE</envar>) with a threshold of
-             90%.
+             database directory
+             (<literal>volatile&nbsp;database&nbsp;directory</literal>,
+             <literal>persistent&nbsp;database&nbsp;directory</literal>,
+             <literal>state&nbsp;database&nbsp;directory</literal>)
+             with a threshold of 90%.
            </para>
          </listitem>
        </varlistentry>

diff --git a/ctdb/doc/ctdb-tunables.7.xml b/ctdb/doc/ctdb-tunables.7.xml
index da01d212fc41bc71faaf8e455133e84a71770161..317add4b63a103707f5edf412577a39b241067cf 100644 (file)
--- a/ctdb/doc/ctdb-tunables.7.xml
+++ b/ctdb/doc/ctdb-tunables.7.xml
@@ -778,6 +778,9 @@ MonitorInterval=20
       <citerefentry><refentrytitle>ctdbd</refentrytitle>
       <manvolnum>1</manvolnum></citerefentry>,
 
+      <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
+      <manvolnum>5</manvolnum></citerefentry>,
+
       <citerefentry><refentrytitle>ctdbd.conf</refentrytitle>
       <manvolnum>5</manvolnum></citerefentry>,
 

diff --git a/ctdb/doc/ctdb.7.xml b/ctdb/doc/ctdb.7.xml
index 9e56aa5506f3bfd7312fc533ea719d53c493aaf1..eb283a834c3dc22e5fd26acd12ffdb9a81e809cb 100644 (file)
--- a/ctdb/doc/ctdb.7.xml
+++ b/ctdb/doc/ctdb.7.xml
@@ -99,10 +99,13 @@
 
     <para>
       By default, the recovery lock is implemented using a file
-      (specified by <parameter>CTDB_RECOVERY_LOCK</parameter>)
-      residing in shared storage (usually) on a cluster filesystem.
-      To support a recovery lock the cluster filesystem must support
-      lock coherence.  See
+      (specified by <parameter>recovery lock</parameter> in the
+      <literal>[cluster]</literal> section of
+      <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
+      <manvolnum>5</manvolnum></citerefentry>) residing in shared
+      storage (usually) on a cluster filesystem.  To support a
+      recovery lock the cluster filesystem must support lock
+      coherence.  See
       <citerefentry><refentrytitle>ping_pong</refentrytitle>
       <manvolnum>1</manvolnum></citerefentry> for more details.
     </para>
@@ -110,12 +113,11 @@
     <para>
       The recovery lock can also be implemented using an arbitrary
       cluster mutex call-out by using an exclamation point ('!') as
-      the first character of
-      <parameter>CTDB_RECOVERY_LOCK</parameter>.  For example, a value
-      of <command>!/usr/local/bin/myhelper recovery</command> would
-      run the given helper with the specified arguments.  See the
-      source code relating to cluster mutexes for clues about writing
-      call-outs.
+      the first character of <parameter>recovery lock</parameter>.
+      For example, a value of <command>!/usr/local/bin/myhelper
+      recovery</command> would run the given helper with the specified
+      arguments.  See the source code relating to cluster mutexes for
+      clues about writing call-outs.
     </para>
 
     <para>
@@ -989,14 +991,14 @@ CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
   </refsect1>
 
   <refsect1>
-    <title>DEBUG LEVELS</title>
+    <title>LOG LEVELS</title>
 
     <para>
-      Valid values for DEBUGLEVEL are:
+      Valid log levels, in increasing order of verbosity, are:
     </para>
 
     <simplelist>
-      <member>ERR</member>
+      <member>ERROR</member>
       <member>WARNING</member>
       <member>NOTICE</member>
       <member>INFO</member>
@@ -1074,6 +1076,9 @@ CTDB_CAPABILITY_RECMASTER=no
       <citerefentry><refentrytitle>ping_pong</refentrytitle>
       <manvolnum>1</manvolnum></citerefentry>,
 
+      <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
+      <manvolnum>5</manvolnum></citerefentry>,
+
       <citerefentry><refentrytitle>ctdbd.conf</refentrytitle>
       <manvolnum>5</manvolnum></citerefentry>,
 

diff --git a/ctdb/doc/ctdb_mutex_ceph_rados_helper.7.xml b/ctdb/doc/ctdb_mutex_ceph_rados_helper.7.xml
index bde5d7200adc6325c64179f93e53c408da90d088..b9a5d3aecc37fdce4e1536700a142f36bdf8cd03 100644 (file)
--- a/ctdb/doc/ctdb_mutex_ceph_rados_helper.7.xml
+++ b/ctdb/doc/ctdb_mutex_ceph_rados_helper.7.xml
@@ -23,11 +23,13 @@
       for CTDB.  When configured, split brain avoidance during CTDB recovery
       will be handled using locks against an object located in a Ceph RADOS
       pool.
-      To enable this functionality, include the following line in your CTDB
-      config file:
+      To enable this functionality, include the following line in the
+      <literal>[cluster]</literal> section of
+      <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
+      <manvolnum>5</manvolnum></citerefentry>:
     </para>
     <screen format="linespecific">
-CTDB_RECOVERY_LOCK="!ctdb_mutex_ceph_rados_helper [Cluster] [User] [Pool] [Object]"
+recovery lock = !ctdb_mutex_ceph_rados_helper [Cluster] [User] [Pool] [Object]
 
 Cluster: Ceph cluster name (e.g. ceph)
 User: Ceph cluster user name (e.g. client.admin)

diff --git a/ctdb/doc/ctdbd.1.xml b/ctdb/doc/ctdbd.1.xml
index 09803e4e24036cef8fa1c2c607f5612f0939b695..07838fe6203b7901d79b73cb9653747d5ad5097e 100644 (file)
--- a/ctdb/doc/ctdbd.1.xml
+++ b/ctdb/doc/ctdbd.1.xml
@@ -82,6 +82,9 @@
       <citerefentry><refentrytitle>onnode</refentrytitle>
       <manvolnum>1</manvolnum></citerefentry>,
 
+      <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
+      <manvolnum>5</manvolnum></citerefentry>,
+
       <citerefentry><refentrytitle>ctdb</refentrytitle>
       <manvolnum>7</manvolnum></citerefentry>,
 

diff --git a/ctdb/utils/etcd/ctdb_etcd_lock b/ctdb/utils/etcd/ctdb_etcd_lock
index 3e7e2bffca4cf5728c47ed0ee8ff8cf6fcff2ecd..000c6bb720896d1a1c4a46b7cd832e08cc7951eb 100755 (executable)
--- a/ctdb/utils/etcd/ctdb_etcd_lock
+++ b/ctdb/utils/etcd/ctdb_etcd_lock
@@ -20,10 +20,10 @@
 This script is intended to be run as a mutex helper for CTDB. It will try to
 connect to an existing etcd cluster and grab an etcd.Lock() to function as
 CTDB's recovery lock. Please see ctdb/doc/cluster_mutex_helper.txt for
-details on what we're SUPPOSED to be doing. :) To use this, include the
-following line in your CTDB config file:
+details on what we're SUPPOSED to be doing. :) To use this, include
+the following line in the ctdb.conf:
 
-CTDB_RECOVERY_LOCK="!/path/to/script"
+    recovery lock = !/path/to/script
 
 You can also pass "-v", "-vv", or "-vvv" to include verbose output in the
 CTDB log. Additional "v"s indicate increases in verbosity.