ctdb-logging: New option CTDB_LOGGING, remove CTDB_LOGFILE, CTDB_SYSLOG
[Samba.git] / ctdb / doc / ctdbd.conf.5.xml
blob898688dc12c9c11da489fe4354e37e3559c92a79
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry
3         PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
4         "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
6 <refentry id="ctdbd.conf.5">
8   <refmeta>
9     <refentrytitle>ctdbd.conf</refentrytitle>
10     <manvolnum>5</manvolnum>
11     <refmiscinfo class="source">ctdb</refmiscinfo>
12     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
13   </refmeta>
15   <refnamediv>
16     <refname>ctdbd.conf</refname>
17     <refpurpose>CTDB daemon configuration file</refpurpose>
18   </refnamediv>
20   <refsect1>
21     <title>DESCRIPTION</title>
23     <para>
24       This file contains CTDB configuration variables that are affect
25       the operation of CTDB.  The default location of this file is
26       <filename>/etc/ctdb/ctdbd.conf</filename>.
27     </para>
29     <para>
30       This file is a shell script (see
31       <citerefentry><refentrytitle>sh</refentrytitle>
32       <manvolnum>1</manvolnum></citerefentry>) but is usually limited
33       to simple variable assignments and shell-style comments.
34     </para>
36     <para>
37       CTDB configuration variables are grouped into several categories below.
38     </para>
40     <para>
41       Variables defined in this document can also be set in a
42       distribution-specific configuration file such as
43       <filename>/etc/sysconfig/ctdb</filename> (Red Hat) or
44       <filename>/etc/default/ctdb</filename> (Debian).  However, these
45       files should be reserved for variables used by the initscript.
46       A historical alternative is
47       <filename>/etc/ctdb/sysconfig/ctdb</filename> - this is
48       deprecated.
49     </para>
51   </refsect1>
53   <refsect1>
54     <title>
55       INITSCRIPT CONFIGURATION
56     </title>
58     <para>
59       Some options must be available to the initscript so they need to
60       be set in the distribution-specific initscript configuration,
61       such as <filename>/etc/sysconfig/ctdb</filename> or
62       <filename>/etc/default/ctdb</filename>.
63     </para>
65     <variablelist>
67       <varlistentry>
68         <term>CTDB_PIDFILE=<parameter>FILENAME</parameter></term>
69         <listitem>
70           <para>
71             FILENAME is the name of the file used to contain the
72             process ID (PID) of the main CTDB daemon when it is
73             running.  This is passed from the initscript to
74             <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
75             <manvolnum>1</manvolnum></citerefentry>.
76           </para>
78           <para>
79             Default is <filename>/var/run/ctdb/ctdbd.pid</filename>.
80             Corresponds to <option>--pidfile</option>.
81           </para>
82         </listitem>
83       </varlistentry>
85     </variablelist>
86   </refsect1>
88   <refsect1>
89     <title>
90       GLOBAL CONFIGURATION
91     </title>
93     <para>
94       These options may be used in the initscripts, daemon and
95       scripts.
96     </para>
98     <variablelist>
100       <varlistentry>
101         <term>CTDB_BASE=<parameter>DIRECTORY</parameter></term>
102         <listitem>
103           <para>
104             DIRECTORY containing CTDB scripts and configuration files.
105           </para>
106         </listitem>
107       </varlistentry>
109       <varlistentry>
110         <term>CTDB_VARDIR=<parameter>DIRECTORY</parameter></term>
111         <listitem>
112           <para>
113             DIRECTORY containing CTDB files that are modified at
114             runtime.
115           </para>
116           <para>
117             Defaults to <filename>/var/ctdb</filename>, unless
118             <filename>/var/lib/ctdb</filename> already exists in which
119             case it is used.
120           </para>
121         </listitem>
122       </varlistentry>
125     </variablelist>
126   </refsect1>
128   <refsect1>
129     <title>
130       DAEMON CONFIGURATION
131     </title>
133     <para>
134       Variables in this section are processed by
135       <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
136       <manvolnum>1</manvolnum></citerefentry> and are converted into
137       command-line arguments to
138       <citerefentry><refentrytitle>ctdbd</refentrytitle>
139       <manvolnum>1</manvolnum></citerefentry>.  Correspondence with
140       <citerefentry><refentrytitle>ctdbd</refentrytitle>
141       <manvolnum>1</manvolnum></citerefentry> options is shown for
142       each variable.  The the documentation for the relevant options
143       for more details.
144     </para>
146     <para>
147       Many of these variables are also used by event scripts.
148     </para>
150     <variablelist>
152       <varlistentry>
153         <term>CTDB_CAPABILITY_LMASTER=yes|no</term>
154         <listitem>
155           <para>
156             Defaults to yes.  Corresponds to <option>--no-lmaster</option>.
157           </para>
158         </listitem>
159       </varlistentry>
161       <varlistentry>
162         <term>CTDB_CAPABILITY_RECMASTER=yes|no</term>
163         <listitem>
164           <para>
165             Defaults to yes.  Corresponds to
166             <option>--no-recmaster</option>.
167           </para>
168         </listitem>
169       </varlistentry>
171       <varlistentry>
172         <term>CTDB_DBDIR=<parameter>DIRECTORY</parameter></term>
173         <listitem>
174           <para>
175             Defaults to <varname>CTDB_VARDIR</varname>.  Corresponds to
176             <option>--dbdir</option>.
177           </para>
178         </listitem>
179       </varlistentry>
181       <varlistentry>
182         <term>CTDB_DBDIR_PERSISTENT=<parameter>DIRECTORY</parameter></term>
183         <listitem>
184           <para>
185             Defaults to <varname>CTDB_VARDIR</varname>/persistent.
186             Corresponds to <option>--dbdir-persistent</option>.
187           </para>
188         </listitem>
189       </varlistentry>
191       <varlistentry>
192         <term>CTDB_DBDIR_STATE=<parameter>DIRECTORY</parameter></term>
193         <listitem>
194           <para>
195             Defaults to <varname>CTDB_VARDIR</varname>/state.
196             Corresponds to <option>--dbdir-state</option>.
197           </para>
198         </listitem>
199       </varlistentry>
201       <varlistentry>
202         <term>CTDB_DEBUGLEVEL=<parameter>DEBUGLEVEL</parameter></term>
203         <listitem>
204           <para>
205             Default is ERR (0).  Corresponds to <option>-d</option> or
206             <option>--debug</option>.
207           </para>
208         </listitem>
209       </varlistentry>
211       <varlistentry>
212         <term>CTDB_EVENT_SCRIPT_DIR=<parameter>DIRECTORY</parameter></term>
213         <listitem>
214           <para>
215             Default is <varname>CTDB_BASE</varname>/events.d, so usually
216             <filename>/etc/ctdb/events.d</filename>.  Corresponds to
217             <option>--event-script-dir</option>.
218           </para>
219         </listitem>
220       </varlistentry>
222       <varlistentry>
223         <term>CTDB_LOGGING=<parameter>STRING</parameter></term>
224         <listitem>
225           <para>
226             STRING specifies where ctdbd will write its log. The
227             default is file:<filename>/var/log/log.ctdb</filename> or
228             similar - the prefix may differ depending on how CTDB was
229             built.  Corresponds to <option>--logging</option>.
230           </para>
231           <para>
232             Valid values are:
233           </para>
234           <variablelist>
235             <varlistentry>
236               <term>file:<parameter>FILENAME</parameter></term>
237               <listitem>
238                 <para>
239                   FILENAME where ctdbd will write its log. This is usually
240                   <filename>/var/log/log.ctdb</filename>.
241                 </para>
242               </listitem>
243             </varlistentry>
244             <varlistentry>
245               <term>syslog</term>
246               <listitem>
247                 <para>
248                   CTDB will log to syslog
249                 </para>
250               </listitem>
251             </varlistentry>
252           </variablelist>
253         </listitem>
254       </varlistentry>
256       <varlistentry>
257         <term>CTDB_LVS_PUBLIC_IP=<parameter>IPADDR</parameter></term>
258         <listitem>
259           <para>
260             No default.  Corresponds to "<option>--lvs</option>
261             <option>--single-public-ip IPADDR"</option>.
262           </para>
263         </listitem>
264       </varlistentry>
266       <varlistentry>
267         <term>CTDB_NODES=<parameter>FILENAME</parameter></term>
268         <listitem>
269           <para>
270             Default is <varname>CTDB_BASE</varname>/nodes, so usually
271             <filename>/etc/ctdb/nodes</filename>.  Corresponds to
272             <option>--nlist</option>.
273           </para>
274         </listitem>
275       </varlistentry>
277       <varlistentry>
278         <term>CTDB_NOTIFY_SCRIPT=<parameter>FILENAME</parameter></term>
279         <listitem>
280           <para>
281             No default, usually
282             <filename>/etc/ctdb/notify.sh</filename>.  Corresponds to
283             <option>--notification-script</option>.
284           </para>
285         </listitem>
286       </varlistentry>
288       <varlistentry>
289         <term>CTDB_MAX_PERSISTENT_CHECK_ERRORS=<parameter>NUM</parameter></term>
290         <listitem>
291           <para>
292             Default 0.  Corresponds to
293             <option>--max-persistent-check-errors</option>.
294           </para>
295         </listitem>
296       </varlistentry>
298       <varlistentry>
299         <term>CTDB_PUBLIC_ADDRESSES=<parameter>FILENAME</parameter></term>
300         <listitem>
301           <para>
302             No default, usually
303             <filename>/etc/ctdb/public_addresses</filename>.
304             Corresponds to <option>--public-addresses</option>.
305           </para>
306         </listitem>
307       </varlistentry>
309       <varlistentry>
310         <term>CTDB_PUBLIC_INTERFACE=<parameter>INTERFACE</parameter></term>
311         <listitem>
312           <para>
313             No default.  Corresponds to
314             <option>--public-interface</option>.
315           </para>
316         </listitem>
317       </varlistentry>
319       <varlistentry>
320         <term>CTDB_RECOVERY_LOCK=<parameter>FILENAME</parameter></term>
321         <listitem>
322           <para>
323             Defaults to
324             <filename>/some/place/on/shared/storage</filename>, which
325             should be change to a useful value.  Corresponds to
326             <option>--reclock</option>.
327           </para>
328         </listitem>
329       </varlistentry>
331       <varlistentry>
332         <term>CTDB_SCRIPT_LOG_LEVEL=<parameter>DEBUGLEVEL</parameter></term>
333         <listitem>
334           <para>
335             Defaults to ERR (0).  Corresponds to
336             <option>--script-log-level</option>.
337           </para>
338         </listitem>
339       </varlistentry>
341       <varlistentry>
342         <term>CTDB_SOCKET=<parameter>FILENAME</parameter></term>
343         <listitem>
344           <para>
345             Defaults to <filename>/tmp/ctdb.socket</filename>.
346             Corresponds to <option>--socket</option>.
347           </para>
348           <para>
349             If you change this then you probably want to set this in
350             root's enviroment (perhaps in a file in
351             <filename>/etc/profile.d</filename>) so that you can use
352             the <citerefentry><refentrytitle>ctdb</refentrytitle>
353             <manvolnum>1</manvolnum></citerefentry> command in a
354             straightforward manner.
355           </para>
356         </listitem>
357       </varlistentry>
359       <varlistentry>
360         <term>CTDB_START_AS_DISABLED=yes|no</term>
361         <listitem>
362           <para>
363             Default is no.  Corresponds to
364             <option>--start-as-disabled</option>.
365           </para>
366         </listitem>
367       </varlistentry>
369       <varlistentry>
370         <term>CTDB_START_AS_STOPPED=yes|no</term>
371         <listitem>
372           <para>
373             Default is no.  Corresponds to
374             <option>--start-as-stopped</option>.
375           </para>
376         </listitem>
377       </varlistentry>
379       <varlistentry>
380         <term>CTDB_TRANSPORT=tcp|infiniband</term>
381         <listitem>
382           <para>
383             Defaults to tcp.  Corresponds to
384             <option>--transport</option>.
385           </para>
386         </listitem>
387       </varlistentry>
389     </variablelist>
391     <para>
392       While the following variables do not translate into daemon
393       options they are used by
394       <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
395       <manvolnum>1</manvolnum></citerefentry> when starting and
396       stopping <citerefentry><refentrytitle>ctdbd</refentrytitle>
397       <manvolnum>1</manvolnum></citerefentry>.
398     </para>
400     <variablelist>
402       <varlistentry>
403         <term>CTDB_SHUTDOWN_TIMEOUT=<parameter>NUM</parameter></term>
404         <listitem>
405           <para>
406             NUM is the number of seconds to wait for
407             <citerefentry><refentrytitle>ctdbd</refentrytitle>
408             <manvolnum>1</manvolnum></citerefentry> to shut down
409             gracefully before giving up and killing it.
410           </para>
412           <para>
413             Defaults is 30.
414           </para>
415         </listitem>
416       </varlistentry>
418       <varlistentry>
419         <term>CTDB_STARTUP_TIMEOUT=<parameter>NUM</parameter></term>
420         <listitem>
421           <para>
422             NUM is the number of seconds to wait for
423             <citerefentry><refentrytitle>ctdbd</refentrytitle>
424             <manvolnum>1</manvolnum></citerefentry> complete early
425             initialisation up to a point where it is unlikely to
426             abort.  If <command>ctdbd</command> doesn't complete the
427             "setup" event before this timeout then it is killed.
428           </para>
430           <para>
431             Defaults is 10.
432           </para>
433         </listitem>
434       </varlistentry>
436     </variablelist>
437   </refsect1>
439   <refsect1>
440     <title>NETWORK CONFIGURATION</title>
442     <refsect2>
443       <title>NAT GATEWAY</title>
445       <para>
446         NAT gateway is used to configure fallback routing for nodes
447         when they do not host any public IP addresses.  For example,
448         it allows unhealthy nodes to reliably communicate with
449         external infrastructure.  One node in a NAT gateway group will
450         be designated as the NAT gateway master node and other (slave)
451         nodes will be configured with fallback routes via the NAT
452         gateway master node.  For more information, see the
453         <citetitle>NAT GATEWAY</citetitle> section in
454         <citerefentry><refentrytitle>ctdb</refentrytitle>
455         <manvolnum>7</manvolnum></citerefentry>.
456       </para>
458       <variablelist>
460         <varlistentry>
461           <term>CTDB_NATGW_DEFAULT_GATEWAY=<parameter>IPADDR</parameter></term>
462           <listitem>
463             <para>
464               IPADDR is an alternate network gateway to use on the NAT
465               gateway master node.  If set, a fallback default route
466               is added via this network gateway.
467             </para>
468             <para>
469               No default.  Setting this variable is optional - if not
470               set that no route is created on the NAT gateway master
471               node.
472             </para>
473           </listitem>
474         </varlistentry>
476         <varlistentry>
477           <term>CTDB_NATGW_NODES=<parameter>FILENAME</parameter></term>
478           <listitem>
479             <para>
480               FILENAME contains the list of nodes that belong to the
481               same NAT gateway group.
482             </para>
483             <para>
484               File format:
485               <screen>
486 <parameter>IPADDR</parameter>
487               </screen>
488             </para>
489             <para>
490               No default, usually
491               <filename>/etc/ctdb/natgw_nodes</filename> when enabled.
492             </para>
493           </listitem>
494         </varlistentry>
496         <varlistentry>
497           <term>CTDB_NATGW_PRIVATE_NETWORK=<parameter>IPADDR/MASK</parameter></term>
498           <listitem>
499             <para>
500               IPADDR/MASK is the private sub-network that is
501               internally routed via the NAT gateway master node.  This
502               is usually the private network that is used for node
503               addresses.
504             </para>
505             <para>
506               No default.
507             </para>
508           </listitem>
509         </varlistentry>
511         <varlistentry>
512           <term>CTDB_NATGW_PUBLIC_IFACE=<parameter>IFACE</parameter></term>
513           <listitem>
514             <para>
515               IFACE is the network interface on which the
516               CTDB_NATGW_PUBLIC_IP will be configured.
517             </para>
518             <para>
519               No default.
520             </para>
521           </listitem>
522         </varlistentry>
524         <varlistentry>
525           <term>CTDB_NATGW_PUBLIC_IP=<parameter>IPADDR/MASK</parameter></term>
526           <listitem>
527             <para>
528               IPADDR/MASK indicates the IP address that is used for
529               outgoing traffic (originating from
530               CTDB_NATGW_PRIVATE_NETWORK) on the NAT gateway master
531               node.  This <emphasis>must not</emphasis> be a
532               configured public IP address.
533             </para>
534             <para>
535               No default.
536             </para>
537           </listitem>
538         </varlistentry>
540         <varlistentry>
541           <term>CTDB_NATGW_SLAVE_ONLY=yes|no</term>
542           <listitem>
543             <para>
544               When set to "yes" a node can not be a NAT gateway master
545               node.  In this case
546               <varname>CTDB_NATGW_PUBLIC_IFACE</varname> and
547               <varname>CTDB_NATGW_PUBLIC_IP</varname> are optional
548               and unused.
549             </para>
550             <para>
551               Default is no.
552             </para>
553           </listitem>
554         </varlistentry>
556         <varlistentry>
557           <term>CTDB_NATGW_STATIC_ROUTES=<parameter>IPADDR/MASK[@GATEWAY]</parameter> ...</term>
558           <listitem>
559             <para>
560               Each IPADDR/MASK identifies a network or host to which
561               NATGW should create a fallback route, instead of
562               creating a single default route.  This can be used when
563               there is already a default route, via an interface that
564               can not reach required infrastructure, that overrides
565               the NAT gateway default route.
566             </para>
567             <para>
568               If GATEWAY is specified then the corresponding route on
569               the NATGW master node will be via GATEWAY.  Such routes
570               are created even if
571               <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is not
572               specified.  If GATEWAY is not specified for some
573               networks then routes are only created on the NATGW
574               master node for those networks if
575               <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is
576               specified.
577             </para>
578             <para>
579               This should be used with care to avoid causing traffic
580               to unnecessarily double-hop through the NAT gateway
581               master, even when a node is hosting public IP addresses.
582               Each specified network or host should probably have a
583               corresponding automatically created link route or static
584               route to avoid this.
585             </para>
586             <para>
587               No default.
588             </para>
589           </listitem>
590         </varlistentry>
592       </variablelist>
594       <refsect3>
595         <title>Example</title>
596         <screen>
597 CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
598 CTDB_NATGW_PRIVATE_NETWORK=192.168.1.0/24
599 CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
600 CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
601 CTDB_NATGW_PUBLIC_IFACE=eth0
602         </screen>
604         <para>
605           A variation that ensures that infrastructure (ADS, DNS, ...)
606           directly attached to the public network (10.0.0.0/24) is
607           always reachable would look like this:
608         </para>
609         <screen>
610 CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
611 CTDB_NATGW_PRIVATE_NETWORK=192.168.1.0/24
612 CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
613 CTDB_NATGW_PUBLIC_IFACE=eth0
614 CTDB_NATGW_STATIC_ROUTES=10.0.0.0/24
615         </screen>
616         <para>
617           Note that <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is
618           not specified.
619         </para>
620       </refsect3>
622     </refsect2>
624     <refsect2>
625       <title>POLICY ROUTING</title>
627       <para>
628         A node running CTDB may be a component of a complex network
629         topology.  In particular, public addresses may be spread
630         across several different networks (or VLANs) and it may not be
631         possible to route packets from these public addresses via the
632         system's default route.  Therefore, CTDB has support for
633         policy routing via the <filename>13.per_ip_routing</filename>
634         eventscript.  This allows routing to be specified for packets
635         sourced from each public address.  The routes are added and
636         removed as CTDB moves public addresses between nodes.
637       </para>
639       <para>
640         For more information, see the <citetitle>POLICY
641         ROUTING</citetitle> section in
642         <citerefentry><refentrytitle>ctdb</refentrytitle>
643         <manvolnum>7</manvolnum></citerefentry>.
644       </para>
646       <variablelist>
647         <varlistentry>
648           <term>CTDB_PER_IP_ROUTING_CONF=<parameter>FILENAME</parameter></term>
649           <listitem>
650             <para>
651               FILENAME contains elements for constructing the desired
652               routes for each source address.
653             </para>
655             <para>
656               The special FILENAME value
657               <constant>__auto_link_local__</constant> indicates that no
658               configuration file is provided and that CTDB should
659               generate reasonable link-local routes for each public IP
660               address.
661             </para>
663             <para>
664               File format:
665               <screen>
666 <parameter>IPADDR</parameter> <parameter>DEST-IPADDR/MASK</parameter> <optional><parameter>GATEWAY-IPADDR</parameter></optional>
667               </screen>
668             </para>
670             <para>
671               No default, usually
672               <filename>/etc/ctdb/policy_routing</filename> when enabled.
673             </para>
674           </listitem>
675         </varlistentry>
677         <varlistentry>
678           <term>CTDB_PER_IP_ROUTING_RULE_PREF=<parameter>NUM</parameter></term>
679         <listitem>
680           <para>
681             NUM sets the priority (or preference) for the routing
682             rules that are added by CTDB.
683           </para>
685           <para>
686             This should be (strictly) greater than 0 and (strictly)
687             less than 32766.  A priority of 100 is recommended, unless
688             this conflicts with a priority already in use on the
689             system.  See
690             <citerefentry><refentrytitle>ip</refentrytitle>
691             <manvolnum>8</manvolnum></citerefentry>, for more details.
692           </para>
693         </listitem>
694         </varlistentry>
696         <varlistentry>
697           <term>
698             CTDB_PER_IP_ROUTING_TABLE_ID_LOW=<parameter>LOW-NUM</parameter>,
699             CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=<parameter>HIGH-NUM</parameter>
700           </term>
701           <listitem>
702             <para>
703               CTDB determines a unique routing table number to use for
704               the routing related to each public address.  LOW-NUM and
705               HIGH-NUM indicate the minimum and maximum routing table
706               numbers that are used.
707             </para>
709             <para>
710               <citerefentry><refentrytitle>ip</refentrytitle>
711               <manvolnum>8</manvolnum></citerefentry> uses some
712               reserved routing table numbers below 255.  Therefore,
713               CTDB_PER_IP_ROUTING_TABLE_ID_LOW should be (strictly)
714               greater than 255.
715             </para>
717             <para>
718               CTDB uses the standard file
719               <filename>/etc/iproute2/rt_tables</filename> to maintain
720               a mapping between the routing table numbers and labels.
721               The label for a public address
722               <replaceable>ADDR</replaceable> will look like
723               ctdb.<replaceable>addr</replaceable>.  This means that
724               the associated rules and routes are easy to read (and
725               manipulate).
726             </para>
728             <para>
729               No default, usually 1000 and 9000.
730             </para>
731           </listitem>
732         </varlistentry>
733       </variablelist>
735       <refsect3>
736         <title>Example</title>
737         <screen>
738 CTDB_PER_IP_ROUTING_CONF=/etc/ctdb/policy_routing
739 CTDB_PER_IP_ROUTING_RULE_PREF=100
740 CTDB_PER_IP_ROUTING_TABLE_ID_LOW=1000
741 CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
742         </screen>
743       </refsect3>
745     </refsect2>
747     <refsect2>
748       <title>MISCELLANEOUS NETWORK CONFIGURATION</title>
750       <variablelist>
752         <varlistentry>
753           <term>CTDB_PARTIALLY_ONLINE_INTERFACES=yes|no</term>
754           <listitem>
755             <para>
756               Whether one or more offline interfaces should cause a
757               monitor event to fail if there are other interfaces that
758               are up.  If this is "yes" and a node has some interfaces
759               that are down then <command>ctdb status</command> will
760               display the node as "PARTIALLYONLINE".
761             </para>
763             <para>
764               Default is "no".
765             </para>
766           </listitem>
767         </varlistentry>
769       </variablelist>
770     </refsect2>
772   </refsect1>
774   <refsect1>
775     <title>SERVICE CONFIGURATION</title>
777     <para>
778       CTDB can be configured to manage and/or monitor various NAS (and
779       other) services via its eventscripts.
780     </para>
782     <para>
783       In the simplest case CTDB will manage a service.  This means the
784       service will be started and stopped along with CTDB, CTDB will
785       monitor the service and CTDB will do any required
786       reconfiguration of the service when public IP addresses are
787       failed over.
788     </para>
790     <refsect2>
791       <title>SAMBA</title>
793       <refsect3>
794         <title>Eventscripts</title>
796         <simplelist>
797           <member><filename>49.winbind</filename></member>
798           <member><filename>50.samba</filename></member>
799         </simplelist>
800       </refsect3>
802       <variablelist>
804         <varlistentry>
805           <term>CTDB_MANAGES_SAMBA=yes|no</term>
806           <listitem>
807             <para>
808               Should CTDB manage Samba?
809             </para>
810             <para>
811               Default is no.
812             </para>
813           </listitem>
814         </varlistentry>
816         <varlistentry>
817           <term>CTDB_MANAGES_WINBIND=yes|no</term>
818           <listitem>
819             <para>
820               Should CTDB manage Winbind?
821             </para>
822             <para>
823               Default is no.
824             </para>
825           </listitem>
826         </varlistentry>
828         <varlistentry>
829           <term>CTDB_SAMBA_CHECK_PORTS=<parameter>PORT-LIST</parameter></term>
830           <listitem>
831             <para>
832               When monitoring Samba, check TCP ports in
833               space-separated PORT-LIST.
834             </para>
835             <para>
836               Default is to monitor ports that Samba is configured to listen on.
837             </para>
838           </listitem>
839         </varlistentry>
841         <varlistentry>
842           <term>CTDB_SAMBA_SKIP_SHARE_CHECK=yes|no</term>
843           <listitem>
844             <para>
845               As part of monitoring, should CTDB skip the check for
846               the existence of each directory configured as share in
847               Samba.  This may be desirable if there is a large number
848               of shares.
849             </para>
850             <para>
851               Default is no.
852             </para>
853           </listitem>
854         </varlistentry>
856         <varlistentry>
857           <term>CTDB_SERVICE_NMB=<parameter>SERVICE</parameter></term>
858           <listitem>
859             <para>
860               Distribution specific SERVICE for managing nmbd.
861             </para>
862             <para>
863               Default is distribution-dependant.
864             </para>
865           </listitem>
866         </varlistentry>
867         <varlistentry>
868           <term>CTDB_SERVICE_SMB=<parameter>SERVICE</parameter></term>
869           <listitem>
870             <para>
871               Distribution specific SERVICE for managing smbd.
872             </para>
873             <para>
874               Default is distribution-dependant.
875             </para>
876           </listitem>
877         </varlistentry>
879         <varlistentry>
880           <term>CTDB_SERVICE_WINBIND=<parameter>SERVICE</parameter></term>
881           <listitem>
882             <para>
883               Distribution specific SERVICE for managing winbindd.
884             </para>
885             <para>
886               Default is "winbind".
887             </para>
888           </listitem>
889         </varlistentry>
891       </variablelist>
893     </refsect2>
895     <refsect2>
896       <title>NFS</title>
898       <para>
899         This includes parameters for the kernel NFS server and the
900         user-space
901         <ulink url="https://github.com/nfs-ganesha/nfs-ganesha/wiki">NFS-Ganesha</ulink>
902         server.
903       </para>
905       <refsect3>
906         <title>Eventscripts</title>
908         <simplelist>
909           <member><filename>60.nfs</filename></member>
910           <member><filename>60.ganesha</filename></member>
911         </simplelist>
912       </refsect3>
914       <variablelist>
916         <varlistentry>
917           <term>CTDB_CLUSTER_FILESYSTEM_TYPE=gpfs</term>
918           <listitem>
919             <para>
920               The type of cluster filesystem to use with NFS-ganesha.
921               Currently only "gpfs" is supported.
922             </para>
923             <para>
924               Default is "gpfs".
925             </para>
926           </listitem>
927         </varlistentry>
929         <varlistentry>
930           <term>CTDB_GANESHA_REC_SUBDIR<parameter>SUBDIR</parameter></term>
931           <listitem>
932             <para>
933               SUBDIR is the name of a top-level subdirectory in the
934               first cluster filesystem.  This subdirectory is used to
935               allow communication between NFS-Ganesha and the
936               <filename>60.ganesha</filename> script.
937             </para>
938             <para>
939               Default is ".ganesha".
940             </para>
941           </listitem>
942         </varlistentry>
944         <varlistentry>
945           <term>CTDB_MANAGES_NFS=yes|no</term>
946           <listitem>
947             <para>
948               Should CTDB manage NFS?
949             </para>
950             <para>
951               Default is no.
952             </para>
953           </listitem>
954         </varlistentry>
956         <varlistentry>
957           <term>CTDB_MONITOR_NFS_THREAD_COUNT=yes|no</term>
958           <listitem>
959             <para>
960               Whether to monitor the NFS kernel server thread count.
961             </para>
962             <para>
963               This works around a limitation in some NFS initscripts
964               where some threads can be stuck in host filesystem calls
965               (perhaps due to slow storage), a restart occurs, some
966               threads don't exit, the start only adds the missing
967               number of threads, the stuck threads exit, and the
968               result is a lower than expected thread count.  Note that
969               if you must also set <varname>RPCNFSDCOUNT</varname>
970               (RedHat/Debian) or <varname>USE_KERNEL_NFSD_NUMBER</varname>
971               (SUSE) in your NFS configuration so the monitoring code
972               knows how many threads there should be - if neither of
973               these are set then this option will be ignored.
974             </para>
975             <para>
976               Default is no.
977             </para>
978           </listitem>
979         </varlistentry>
981         <varlistentry>
982           <term>CTDB_NFS_DUMP_STUCK_THREADS=<parameter>NUM</parameter></term>
983           <listitem>
984             <para>
985               NUM is the number of NFS kernel server threads to dump
986               stack traces for if some are still alive after stopping
987               NFS during a restart.
988             </para>
989             <para>
990               Default is 5.  Set this to 0 to disable this feature.
991             </para>
992           </listitem>
993         </varlistentry>
995         <varlistentry>
996           <term>CTDB_NFS_SERVER_MODE=kernel|ganesha</term>
997           <listitem>
998             <para>
999               Selects which NFS server to be managed.
1000             </para>
1001             <para>
1002               This replaces the deprecated variable
1003               <varname>NFS_SERVER_MODE</varname>.
1004             </para>
1005             <para>
1006               Default is "kernel".
1007             </para>
1008           </listitem>
1009         </varlistentry>
1011         <varlistentry>
1012           <term>CTDB_NFS_SKIP_KNFSD_ALIVE_CHECK=yes|no</term>
1013           <listitem>
1014             <para>
1015               During monitoring, should CTDB skip the
1016               <command>rpcinfo</command> check that is used to see if
1017               the NFS kernel server is functional.
1018             </para>
1019             <para>
1020               Default is no.
1021             </para>
1022           </listitem>
1023         </varlistentry>
1025         <varlistentry>
1026           <term>CTDB_NFS_SKIP_SHARE_CHECK=yes|no</term>
1027           <listitem>
1028             <para>
1029               As part of monitoring, should CTDB skip the check for
1030               the existence of each directory exported via NFS.  This
1031               may be desirable if there is a large number of exports.
1032             </para>
1033             <para>
1034               Default is no.
1035             </para>
1036           </listitem>
1037         </varlistentry>
1039         <varlistentry>
1040           <term>CTDB_RPCINFO_LOCALHOST=<parameter>IPADDR</parameter>|<parameter>HOSTNAME</parameter></term>
1041           <listitem>
1042             <para>
1043               IPADDR or HOSTNAME indicates the address that
1044               <command>rpcinfo</command> should connect to when doing
1045               <command>rpcinfo</command> check on RPC service during
1046               monitoring.  Optimally this would be "localhost".
1047               However, this can add some performance overheads.
1048             </para>
1049             <para>
1050               Default is "127.0.0.1".
1051             </para>
1052           </listitem>
1053         </varlistentry>
1055         <varlistentry>
1056           <term>CTDB_SKIP_GANESHA_NFSD_CHECK=yes|no</term>
1057           <listitem>
1058             <para>
1059               As part of monitoring, should CTDB skip the check for
1060               the existence of each directory exported via
1061               NFS-Ganesha.  This may be desirable if there is a large
1062               number of exports.
1063             </para>
1064             <para>
1065               Default is no.
1066             </para>
1067           </listitem>
1068         </varlistentry>
1070       </variablelist>
1072     </refsect2>
1074     <refsect2>
1075       <title>APACHE HTTPD</title>
1077       <para>
1078         CTDB can manage the Apache web server.
1079       </para>
1081       <refsect3>
1082         <title>Eventscript</title>
1084         <simplelist>
1085           <member><filename>41.httpd</filename></member>
1086         </simplelist>
1087       </refsect3>
1089       <variablelist>
1090         <varlistentry>
1091           <term>CTDB_MANAGES_HTTPD=yes|no</term>
1092           <listitem>
1093             <para>
1094               Should CTDB manage the Apache web server?
1095             </para>
1096             <para>
1097               Default is no.
1098             </para>
1099           </listitem>
1100         </varlistentry>
1101       </variablelist>
1102     </refsect2>
1104     <refsect2>
1105       <title>CLAMAV</title>
1107       <para>
1108         CTDB has support to manage the popular anti-virus daemon
1109         ClamAV.
1110       </para>
1112       <refsect3>
1113         <title>Eventscript</title>
1115         <simplelist>
1116           <member><filename>31.clamd</filename></member>
1117         </simplelist>
1119         <para>
1120           This eventscript is not enabled by default.  Use
1121           <command>ctdb enablescript</command> to enable it.
1122         </para>
1124       </refsect3>
1126       <variablelist>
1128         <varlistentry>
1129           <term>CTDB_MANAGES_CLAMD=yes|no</term>
1130           <listitem>
1131             <para>
1132               Should CTDB manage ClamAV?
1133             </para>
1134             <para>
1135               Default is no.
1136             </para>
1137           </listitem>
1138         </varlistentry>
1140         <varlistentry>
1141           <term>CTDB_CLAMD_SOCKET=<parameter>FILENAME</parameter></term>
1142           <listitem>
1143             <para>
1144               FILENAME is the socket to monitor ClamAV.
1145             </para>
1146             <para>
1147               No default.
1148             </para>
1149           </listitem>
1150         </varlistentry>
1152       </variablelist>
1154     </refsect2>
1156     <refsect2>
1157       <title>ISCSI</title>
1159       <para>
1160         CTDB has support for managing the Linux iSCSI tgtd service.
1161       </para>
1163       <refsect3>
1164         <title>Eventscript</title>
1166         <simplelist>
1167           <member><filename>70.iscsi</filename></member>
1168         </simplelist>
1169       </refsect3>
1171       <variablelist>
1173         <varlistentry>
1174           <term>CTDB_MANAGES_ISCSI=yes|no</term>
1175           <listitem>
1176             <para>
1177               Should CTDB manage iSCSI tgtd?
1178             </para>
1179             <para>
1180               Default is no.
1181             </para>
1182           </listitem>
1183         </varlistentry>
1185         <varlistentry>
1186           <term>CTDB_START_ISCSI_SCRIPTS=<parameter>DIRECTORY</parameter></term>
1187           <listitem>
1188             <para>
1189               DIRECTORY on shared storage containing scripts to start
1190               tgtd for each public IP address.
1191             </para>
1192             <para>
1193               No default.
1194             </para>
1195           </listitem>
1196         </varlistentry>
1197       </variablelist>
1198     </refsect2>
1200     <refsect2>
1201       <title>MULTIPATHD</title>
1203       <para>
1204         CTDB can monitor multipath devices to ensure that active paths
1205         are available.
1206       </para>
1208       <refsect3>
1209         <title>Eventscript</title>
1211         <simplelist>
1212           <member><filename>20.multipathd</filename></member>
1213         </simplelist>
1215         <para>
1216           This eventscript is not enabled by default.  Use
1217           <command>ctdb enablescript</command> to enable it.
1218         </para>
1219       </refsect3>
1221       <variablelist>
1222         <varlistentry>
1223           <term>CTDB_MONITOR_MPDEVICES=<parameter>MP-DEVICE-LIST</parameter></term>
1224           <listitem>
1225             <para>
1226               MP-DEVICE-LIST is a list of multipath devices for CTDB to monitor?
1227             </para>
1228             <para>
1229               No default.
1230             </para>
1231           </listitem>
1232         </varlistentry>
1233       </variablelist>
1234     </refsect2>
1236     <refsect2>
1237       <title>VSFTPD</title>
1239       <para>
1240         CTDB can manage the vsftpd FTP server.
1241       </para>
1243       <refsect3>
1244         <title>Eventscript</title>
1246         <simplelist>
1247           <member><filename>40.vsftpd</filename></member>
1248         </simplelist>
1249       </refsect3>
1251       <variablelist>
1252         <varlistentry>
1253           <term>CTDB_MANAGES_VSFTPD=yes|no</term>
1254           <listitem>
1255             <para>
1256               Should CTDB manage the vsftpd FTP server?
1257             </para>
1258             <para>
1259               Default is no.
1260             </para>
1261           </listitem>
1262         </varlistentry>
1263       </variablelist>
1264     </refsect2>
1266     <refsect2>
1267       <title>
1268         SYSTEM RESOURCE MONITORING CONFIGURATION
1269       </title>
1271       <para>
1272         CTDB can experience seemingly random (performance and other)
1273         issues if system resources become too contrained.  Options in
1274         this section can be enabled to allow certain system resources to
1275         be checked.
1276       </para>
1278       <refsect3>
1279         <title>Eventscripts</title>
1281         <simplelist>
1282           <member><filename>00.ctdb</filename></member>
1283           <member><filename>40.fs_use</filename></member>
1284         </simplelist>
1286         <para>
1287           Filesystem usage monitoring is in
1288           <filename>40.fs_use</filename>.  This eventscript is not
1289           enabled by default.  Use <command>ctdb
1290           enablescript</command> to enable it.
1291         </para>
1292       </refsect3>
1294       <variablelist>
1296         <varlistentry>
1297           <term>CTDB_CHECK_FS_USE=<parameter>FS-LIMIT-LIST</parameter></term>
1298           <listitem>
1299             <para>
1300               FS-LIMIT-LIST is a space-separated list of
1301               <parameter>FILESYSTEM</parameter>:<parameter>LIMIT</parameter>
1302               pairs indicating that a node should be flagged unhealthy
1303               if the space used on FILESYSTEM reaches LIMIT%.
1304             </para>
1306             <para>
1307               No default.
1308             </para>
1310             <para>
1311               Note that this feature uses the
1312               <filename>40.fs_use</filename> eventscript, which is not
1313               enabled by default.  Use <command>ctdb
1314               enablescript</command> to enable it.
1315             </para>
1316           </listitem>
1317         </varlistentry>
1319         <varlistentry>
1320           <term>CTDB_CHECK_SWAP_IS_NOT_USED=yes|no</term>
1321           <listitem>
1322             <para>
1323               Should a warning be logged if swap space is in use.
1324             </para>
1325             <para>
1326               Default is no.
1327             </para>
1328           </listitem>
1329         </varlistentry>
1331         <varlistentry>
1332           <term>CTDB_MONITOR_FREE_MEMORY=<parameter>NUM</parameter></term>
1333           <listitem>
1334             <para>
1335               NUM is a lower limit on available system memory, expressed
1336               in megabytes.  If this is set and the amount of available
1337               memory falls below this limit then some debug information
1338               will be logged, the node will be disabled and then CTDB
1339               will be shut down.
1340             </para>
1341             <para>
1342               No default.
1343             </para>
1344           </listitem>
1345         </varlistentry>
1347         <varlistentry>
1348           <term>CTDB_MONITOR_FREE_MEMORY_WARN=<parameter>NUM</parameter></term>
1349           <listitem>
1350             <para>
1351               NUM is a lower limit on available system memory, expressed
1352               in megabytes.  If this is set and the amount of available
1353               memory falls below this limit then a warning will be
1354               logged.
1355             </para>
1356             <para>
1357               No default.
1358             </para>
1359           </listitem>
1360         </varlistentry>
1362       </variablelist>
1363     </refsect2>
1365     <refsect2>
1366       <title>MISCELLANEOUS SERVICE-RELATED CONFIGURATION</title>
1368       <variablelist>
1370         <varlistentry>
1371           <term>CTDB_MANAGED_SERVICES=<parameter>SERVICE-LIST</parameter></term>
1372           <listitem>
1373             <para>
1374               SERVICE-LIST is a space-separated list of SERVICEs that
1375               CTDB should manage.  This can be used as an alternative
1376               to the
1377               <varname>CTDB_MANAGES_<replaceable>SERVICE</replaceable></varname>
1378               variables.
1379             </para>
1380             <para>
1381               No default.
1382             </para>
1383           </listitem>
1384         </varlistentry>
1386         <varlistentry>
1387           <term>CTDB_SERVICE_AUTOSTARTSTOP=yes|no</term>
1388           <listitem>
1389             <para>
1390               When CTDB should start and stop services if they become
1391               managed or unmanaged.
1392             </para>
1393             <para>
1394               Default is no.
1395             </para>
1396           </listitem>
1397         </varlistentry>
1399       </variablelist>
1401     </refsect2>
1403   </refsect1>
1405   <refsect1>
1406     <title>
1407       TUNABLES CONFIGURATION
1408     </title>
1410     <para>
1411       CTDB tunables (see
1412       <citerefentry><refentrytitle>ctdbd-tunables</refentrytitle>
1413       <manvolnum>7</manvolnum></citerefentry>) can be set from the
1414       configuration file.  They are set as follows:
1416       <literallayout>
1417 CTDB_SET_<replaceable>TUNABLE</replaceable>=<replaceable>VALUE</replaceable>
1418       </literallayout>
1419     </para>
1421     <para>
1422       For example:
1424       <screen format="linespecific">
1425 CTDB_SET_MonitorInterval=20
1426       </screen>
1427     </para>
1428   </refsect1>
1430   <refsect1>
1431     <title>
1432       DEBUG AND TEST
1433     </title>
1435     <para>
1436       Variable in this section are for debugging and testing CTDB.
1437       They should not generally be needed.
1438     </para>
1440     <variablelist>
1442       <varlistentry>
1443         <term>CTDB_DEBUG_HUNG_SCRIPT=<parameter>FILENAME</parameter></term>
1444         <listitem>
1445           <para>
1446             FILENAME is a script to run to log debug information when
1447             an event script times out.
1448           </para>
1449           <para>
1450             Default is <filename><varname>CTDB_BASE</varname>/debug-hung-script.sh</filename>.
1451           </para>
1452         </listitem>
1453       </varlistentry>
1455       <varlistentry>
1456         <term>CTDB_DEBUG_HUNG_SCRIPT_LOGFILE=<parameter>FILENAME</parameter></term>
1457         <listitem>
1458           <para>
1459             FILENAME specifies where log messages should go when
1460             debugging hung eventscripts.  This is a testing option.
1461             See also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
1462           </para>
1463           <para>
1464             No default.  Messages go to stdout/stderr and are logged
1465             to the same place as other CTDB log messages.
1466           </para>
1467         </listitem>
1468       </varlistentry>
1470       <varlistentry>
1471         <term>CTDB_DEBUG_HUNG_SCRIPT_STACKPAT=<parameter>REGEXP</parameter></term>
1472         <listitem>
1473           <para>
1474             REGEXP specifies interesting processes for which stack
1475             traces should be logged when debugging hung eventscripts
1476             and those processes are matched in pstree output.  See
1477             also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
1478           </para>
1479           <para>
1480             Default is "exportfs\|rpcinfo".
1481           </para>
1482         </listitem>
1483       </varlistentry>
1485       <varlistentry>
1486         <term>CTDB_DEBUG_LOCKS=<parameter>FILENAME</parameter></term>
1487         <listitem>
1488           <para>
1489             FILENAME is a script to run to log debug information when
1490             an CTDB fails to freeze databases during recovery.
1491           </para>
1492           <para>
1493             No default, usually
1494             <filename><varname>CTDB_BASE</varname>/debug_locks.sh</filename>.
1495           </para>
1496         </listitem>
1497       </varlistentry>
1499       <varlistentry>
1500         <term>CTDB_ETCDIR=<parameter>DIRECTORY</parameter></term>
1501         <listitem>
1502           <para>
1503             DIRECTORY containing system configuration files.  This is
1504             used to provide alternate configuration when testing and
1505             should not need to be changed from the default.
1506           </para>
1507           <para>
1508             Default is <filename>/etc</filename>.
1509           </para>
1510         </listitem>
1511       </varlistentry>
1513       <varlistentry>
1514         <term>CTDB_INIT_STYLE=debian|redhat|suse</term>
1515         <listitem>
1516           <para>
1517             This is the init style used by the Linux distribution (or
1518             other operating system) being used.  This is usually
1519             determined dynamically by checking the system.  This
1520             variable is used by the initscript to determine which init
1521             system primitives to use.  It is also used by some
1522             eventscripts to choose the name of initscripts for certain
1523             services, since these can vary between distributions.
1524           </para>
1525           <para>
1526             No fixed default.
1527           </para>
1528           <para>
1529             If this option needs to be changed from the calculated
1530             default for the initscript to function properly, then it
1531             must be set in the distribution-specific initscript
1532             configuration, such as
1533             <filename>/etc/sysconfig/ctdb</filename>
1534           </para>
1535         </listitem>
1536       </varlistentry>
1538       <varlistentry>
1539         <term>CTDB_MAX_CORRUPT_DB_BACKUPS=<parameter>NUM</parameter></term>
1540         <listitem>
1541           <para>
1542             NUM is the maximum number of volatile TDB database backups
1543             to be kept (for each database) when a corrupt database is
1544             found during startup.  Volatile TDBs are zeroed during
1545             startup so backups are needed to debug any corruption that
1546             occurs before a restart.
1547           </para>
1548           <para>
1549             Default is 10.
1550           </para>
1551         </listitem>
1552       </varlistentry>
1554       <varlistentry>
1555         <term>CTDB_RC_LOCAL=<parameter>FILENAME</parameter></term>
1556         <listitem>
1557           <para>
1558             FILENAME is a script fragment to be sourced by the
1559             <filename>functions</filename> that is sourced by scripts.
1560             On example use would be to override function definitions
1561             in unit tests.  As a sanity check, this file must be
1562             executable for it to be used.
1563           </para>
1564           <para>
1565             No default.
1566           </para>
1567         </listitem>
1568       </varlistentry>
1570       <varlistentry>
1571         <term>CTDB_RUN_TIMEOUT_MONITOR=yes|no</term>
1572         <listitem>
1573           <para>
1574             Whether CTDB should simulate timing out monitor events.
1575             This uses the <filename>99.timeout</filename> eventscript.
1576           </para>
1577           <para>
1578             Default is no.
1579           </para>
1580         </listitem>
1581       </varlistentry>
1583       <varlistentry>
1584         <term>CTDB_SCRIPT_DEBUGLEVEL=<parameter>NUM</parameter></term>
1585         <listitem>
1586           <para>
1587             NUM is the level debugging messages printed by CTDB
1588             scripts.  Setting this to a higher number (e.g. 4) will
1589             cause some scripts to log more messages.
1590           </para>
1591           <para>
1592             Default is 2.
1593           </para>
1594         </listitem>
1595       </varlistentry>
1597       <varlistentry>
1598         <term>CTDB_SUPPRESS_COREFILE=yes|no</term>
1599         <listitem>
1600           <para>
1601             Whether CTDB core files should be suppressed.
1602           </para>
1603           <para>
1604             Default is no.
1605           </para>
1606         </listitem>
1607       </varlistentry>
1609       <varlistentry>
1610         <term>CTDB_VALGRIND=yes|no|<parameter>COMMAND</parameter></term>
1611         <listitem>
1612           <para>
1613             If "yes", this causes
1614             <citerefentry><refentrytitle>ctdbd</refentrytitle>
1615             <manvolnum>1</manvolnum></citerefentry> to be run under
1616             <citerefentry><refentrytitle>valgrind</refentrytitle>
1617             <manvolnum>1</manvolnum></citerefentry> with logs going to
1618             <filename>/var/log/ctdb_valgrind</filename>.  If neither
1619             "yes" nor "no" then the value is assumed to be a COMMAND
1620             (e.g. a <command>valgrind</command> variation, a
1621             <citerefentry><refentrytitle>gdb</refentrytitle>
1622             <manvolnum>1</manvolnum></citerefentry> command) that is
1623             used in place of the default <command>valgrind</command>
1624             command.  In either case, the <option>--valgrind</option>
1625             option is passed to <command>ctdbd</command>.
1626           </para>
1627           <para>
1628             Default is no.
1629           </para>
1630         </listitem>
1631       </varlistentry>
1633     </variablelist>
1635   </refsect1>
1638   <refsect1>
1639     <title>FILES</title>
1641     <simplelist>
1642       <member><filename>/etc/ctdb/ctdbd.conf</filename></member>
1643       <member><filename>/etc/sysconfig/ctdb</filename></member>
1644       <member><filename>/etc/default/ctdb</filename></member>
1645       <member><filename>/etc/ctdb/sysconfig/ctdb</filename></member>
1646     </simplelist>
1647   </refsect1>
1649   <refsect1>
1650     <title>SEE ALSO</title>
1651     <para>
1652       <citerefentry><refentrytitle>ctdbd</refentrytitle>
1653       <manvolnum>1</manvolnum></citerefentry>,
1655       <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
1656       <manvolnum>1</manvolnum></citerefentry>,
1658       <citerefentry><refentrytitle>onnode</refentrytitle>
1659       <manvolnum>1</manvolnum></citerefentry>,
1661       <citerefentry><refentrytitle>ctdb</refentrytitle>
1662       <manvolnum>7</manvolnum></citerefentry>,
1664       <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
1665       <manvolnum>7</manvolnum></citerefentry>,
1667       <ulink url="http://ctdb.samba.org/"/>
1668     </para>
1669   </refsect1>
1671   <refentryinfo>
1672     <author>
1673       <contrib>
1674         This documentation was written by
1675         Amitay Isaacs,
1676         Martin Schwenke
1677       </contrib>
1678     </author>
1680     <copyright>
1681       <year>2007</year>
1682       <holder>Andrew Tridgell</holder>
1683       <holder>Ronnie Sahlberg</holder>
1684     </copyright>
1685     <legalnotice>
1686       <para>
1687         This program is free software; you can redistribute it and/or
1688         modify it under the terms of the GNU General Public License as
1689         published by the Free Software Foundation; either version 3 of
1690         the License, or (at your option) any later version.
1691       </para>
1692       <para>
1693         This program is distributed in the hope that it will be
1694         useful, but WITHOUT ANY WARRANTY; without even the implied
1695         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
1696         PURPOSE.  See the GNU General Public License for more details.
1697       </para>
1698       <para>
1699         You should have received a copy of the GNU General Public
1700         License along with this program; if not, see
1701         <ulink url="http://www.gnu.org/licenses"/>.
1702       </para>
1703     </legalnotice>
1704   </refentryinfo>
1706 </refentry>