From: Martin Schwenke Date: Sat, 21 Apr 2018 08:12:53 +0000 (+1000) Subject: ctdb-docs: Add ctdb.conf(5) cross references and documentation tweaks X-Git-Tag: ldb-1.4.0~165 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=409b0b797ef345d270f1b0f55bb8691088245c20;p=thirdparty%2Fsamba.git ctdb-docs: Add ctdb.conf(5) cross references and documentation tweaks Minor updates to other manual pages for compatibility. Signed-off-by: Martin Schwenke Reviewed-by: Amitay Isaacs --- diff --git a/ctdb/doc/ctdb-etcd.7.xml b/ctdb/doc/ctdb-etcd.7.xml index 59acece321b..5d7a0e05366 100644 --- 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 ctdb/doc/cluster_mutex_helper.txt 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 [cluster] section of + ctdb.conf + 5: -CTDB_RECOVERY_LOCK="!/usr/local/usr/libexec/ctdb/ctdb_etcd_lock" +recovery lock = !/usr/local/usr/libexec/ctdb/ctdb_etcd_lock 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 22cdd371bd2..ad7f352f5c7 100644 --- 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 Default is to warn for each filesystem containing a - database directory (CTDB_DBDIR, - CTDB_DBDIR_PERSISTENT, - CTDB_DBDIR_STATE) with a threshold of - 90%. + database directory + (volatile database directory, + persistent database directory, + state database directory) + with a threshold of 90%. diff --git a/ctdb/doc/ctdb-tunables.7.xml b/ctdb/doc/ctdb-tunables.7.xml index da01d212fc4..317add4b63a 100644 --- a/ctdb/doc/ctdb-tunables.7.xml +++ b/ctdb/doc/ctdb-tunables.7.xml @@ -778,6 +778,9 @@ MonitorInterval=20 ctdbd 1, + ctdb.conf + 5, + ctdbd.conf 5, diff --git a/ctdb/doc/ctdb.7.xml b/ctdb/doc/ctdb.7.xml index 9e56aa5506f..eb283a834c3 100644 --- a/ctdb/doc/ctdb.7.xml +++ b/ctdb/doc/ctdb.7.xml @@ -99,10 +99,13 @@ By default, the recovery lock is implemented using a file - (specified by CTDB_RECOVERY_LOCK) - residing in shared storage (usually) on a cluster filesystem. - To support a recovery lock the cluster filesystem must support - lock coherence. See + (specified by recovery lock in the + [cluster] section of + ctdb.conf + 5) residing in shared + storage (usually) on a cluster filesystem. To support a + recovery lock the cluster filesystem must support lock + coherence. See ping_pong 1 for more details. @@ -110,12 +113,11 @@ The recovery lock can also be implemented using an arbitrary cluster mutex call-out by using an exclamation point ('!') as - the first character of - CTDB_RECOVERY_LOCK. For example, a value - of !/usr/local/bin/myhelper recovery 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 recovery lock. + For example, a value of !/usr/local/bin/myhelper + recovery would run the given helper with the specified + arguments. See the source code relating to cluster mutexes for + clues about writing call-outs. @@ -989,14 +991,14 @@ CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1 - DEBUG LEVELS + LOG LEVELS - Valid values for DEBUGLEVEL are: + Valid log levels, in increasing order of verbosity, are: - ERR + ERROR WARNING NOTICE INFO @@ -1074,6 +1076,9 @@ CTDB_CAPABILITY_RECMASTER=no ping_pong 1, + ctdb.conf + 5, + ctdbd.conf 5, diff --git a/ctdb/doc/ctdb_mutex_ceph_rados_helper.7.xml b/ctdb/doc/ctdb_mutex_ceph_rados_helper.7.xml index bde5d7200ad..b9a5d3aecc3 100644 --- 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 + [cluster] section of + ctdb.conf + 5: -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 09803e4e240..07838fe6203 100644 --- a/ctdb/doc/ctdbd.1.xml +++ b/ctdb/doc/ctdbd.1.xml @@ -82,6 +82,9 @@ onnode 1, + ctdb.conf + 5, + ctdb 7, diff --git a/ctdb/utils/etcd/ctdb_etcd_lock b/ctdb/utils/etcd/ctdb_etcd_lock index 3e7e2bffca4..000c6bb7208 100755 --- 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.