1 <?xml version="1.0" encoding="iso-8859-1"?>
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">
9 <refentrytitle>ctdbd.conf</refentrytitle>
10 <manvolnum>5</manvolnum>
11 <refmiscinfo class="source">ctdb</refmiscinfo>
12 <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
16 <refname>ctdbd.conf</refname>
17 <refpurpose>CTDB daemon configuration file</refpurpose>
21 <title>DESCRIPTION</title>
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>.
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.
37 CTDB configuration variables are grouped into several categories below.
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
55 INITSCRIPT CONFIGURATION
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>.
68 <term>CTDB_PIDFILE=<parameter>FILENAME</parameter></term>
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>.
79 Default is <filename>/var/run/ctdb/ctdbd.pid</filename>.
80 Corresponds to <option>--pidfile</option>.
94 These options may be used in the initscripts, daemon and
101 <term>CTDB_BASE=<parameter>DIRECTORY</parameter></term>
104 DIRECTORY containing CTDB scripts and configuration files.
110 <term>CTDB_VARDIR=<parameter>DIRECTORY</parameter></term>
113 DIRECTORY containing CTDB files that are modified at
117 Defaults to <filename>/var/ctdb</filename>, unless
118 <filename>/var/lib/ctdb</filename> already exists in which
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
147 Many of these variables are also used by event scripts.
153 <term>CTDB_CAPABILITY_LMASTER=yes|no</term>
156 Defaults to yes. Corresponds to <option>--no-lmaster</option>.
162 <term>CTDB_CAPABILITY_RECMASTER=yes|no</term>
165 Defaults to yes. Corresponds to
166 <option>--no-recmaster</option>.
172 <term>CTDB_DBDIR=<parameter>DIRECTORY</parameter></term>
175 Defaults to <varname>CTDB_VARDIR</varname>. Corresponds to
176 <option>--dbdir</option>.
182 <term>CTDB_DBDIR_PERSISTENT=<parameter>DIRECTORY</parameter></term>
185 Defaults to <varname>CTDB_VARDIR</varname>/persistent.
186 Corresponds to <option>--dbdir-persistent</option>.
192 <term>CTDB_DBDIR_STATE=<parameter>DIRECTORY</parameter></term>
195 Defaults to <varname>CTDB_VARDIR</varname>/state.
196 Corresponds to <option>--dbdir-state</option>.
202 <term>CTDB_DEBUGLEVEL=<parameter>DEBUGLEVEL</parameter></term>
205 Default is ERR (0). Corresponds to <option>-d</option> or
206 <option>--debug</option>.
212 <term>CTDB_EVENT_SCRIPT_DIR=<parameter>DIRECTORY</parameter></term>
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>.
223 <term>CTDB_LOGFILE=<parameter>FILENAME</parameter></term>
226 Defaults to <filename>/var/log/log.ctdb</filename>.
227 Corresponds to <option>--logfile</option>. See also
228 <citetitle>CTDB_SYSLOG</citetitle>.
234 <term>CTDB_LOG_RINGBUF_SIZE=<parameter>NUM</parameter></term>
237 Default is 0. Corresponds to
238 <option>--log-ringbuf-size</option>.
244 <term>CTDB_LVS_PUBLIC_IP=<parameter>IPADDR</parameter></term>
247 No default. Corresponds to "<option>--lvs</option>
248 <option>--single-public-ip IPADDR"</option>.
254 <term>CTDB_NODES=<parameter>FILENAME</parameter></term>
257 Default is <varname>CTDB_BASE</varname>/nodes, so usually
258 <filename>/etc/ctdb/nodes</filename>. Corresponds to
259 <option>--nlist</option>.
265 <term>CTDB_NOTIFY_SCRIPT=<parameter>FILENAME</parameter></term>
269 <filename>/etc/ctdb/notify.sh</filename>. Corresponds to
270 <option>--notification-script</option>.
276 <term>CTDB_MAX_PERSISTENT_CHECK_ERRORS=<parameter>NUM</parameter></term>
279 Default 0. Corresponds to
280 <option>--max-persistent-check-errors</option>.
286 <term>CTDB_PUBLIC_ADDRESSES=<parameter>FILENAME</parameter></term>
290 <filename>/etc/ctdb/public_addresses</filename>.
291 Corresponds to <option>--public-addresses</option>.
297 <term>CTDB_PUBLIC_INTERFACE=<parameter>INTERFACE</parameter></term>
300 No default. Corresponds to
301 <option>--public-interface</option>.
307 <term>CTDB_RECOVERY_LOCK=<parameter>FILENAME</parameter></term>
311 <filename>/some/place/on/shared/storage</filename>, which
312 should be change to a useful value. Corresponds to
313 <option>--reclock</option>.
319 <term>CTDB_SCRIPT_LOG_LEVEL=<parameter>DEBUGLEVEL</parameter></term>
322 Defaults to ERR (0). Corresponds to
323 <option>--script-log-level</option>.
329 <term>CTDB_SOCKET=<parameter>FILENAME</parameter></term>
332 Defaults to <filename>/tmp/ctdb.socket</filename>.
333 Corresponds to <option>--socket</option>.
336 If you change this then you probably want to set this in
337 root's enviroment (perhaps in a file in
338 <filename>/etc/profile.d</filename>) so that you can use
339 the <citerefentry><refentrytitle>ctdb</refentrytitle>
340 <manvolnum>1</manvolnum></citerefentry> command in a
341 straightforward manner.
347 <term>CTDB_START_AS_DISABLED=yes|no</term>
350 Default is no. Corresponds to
351 <option>--start-as-disabled</option>.
357 <term>CTDB_START_AS_STOPPED=yes|no</term>
360 Default is no. Corresponds to
361 <option>--start-as-stopped</option>.
367 <term>CTDB_SYSLOG=yes|no</term>
370 Default is no. Corresponds to <option>--syslog</option>.
376 <term>CTDB_TRANSPORT=tcp|infiniband</term>
379 Defaults to tcp. Corresponds to
380 <option>--transport</option>.
388 While the following variables do not translate into daemon
389 options they are used by
390 <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
391 <manvolnum>1</manvolnum></citerefentry> when starting and
392 stopping <citerefentry><refentrytitle>ctdbd</refentrytitle>
393 <manvolnum>1</manvolnum></citerefentry>.
399 <term>CTDB_SHUTDOWN_TIMEOUT=<parameter>NUM</parameter></term>
402 NUM is the number of seconds to wait for
403 <citerefentry><refentrytitle>ctdbd</refentrytitle>
404 <manvolnum>1</manvolnum></citerefentry> to shut down
405 gracefully before giving up and killing it.
415 <term>CTDB_STARTUP_TIMEOUT=<parameter>NUM</parameter></term>
418 NUM is the number of seconds to wait for
419 <citerefentry><refentrytitle>ctdbd</refentrytitle>
420 <manvolnum>1</manvolnum></citerefentry> complete early
421 initialisation up to a point where it is unlikely to
422 abort. If <command>ctdbd</command> doesn't complete the
423 "setup" event before this timeout then it is killed.
436 <title>NETWORK CONFIGURATION</title>
439 <title>NAT GATEWAY</title>
442 NAT gateway is used to configure fallback routing for nodes
443 when they do not host any public IP addresses. For example,
444 it allows unhealthy nodes to reliably communicate with
445 external infrastructure. One node in a NAT gateway group will
446 be designated as the NAT gateway master node and other (slave)
447 nodes will be configured with fallback routes via the NAT
448 gateway master node. For more information, see the
449 <citetitle>NAT GATEWAY</citetitle> section in
450 <citerefentry><refentrytitle>ctdb</refentrytitle>
451 <manvolnum>7</manvolnum></citerefentry>.
457 <term>CTDB_NATGW_DEFAULT_GATEWAY=<parameter>IPADDR</parameter></term>
460 IPADDR is an alternate network gateway to use on the NAT
461 gateway master node. If set, a fallback default route
462 is added via this network gateway.
465 No default. Setting this variable is optional - if not
466 set that no route is created on the NAT gateway master
473 <term>CTDB_NATGW_NODES=<parameter>FILENAME</parameter></term>
476 FILENAME contains the list of nodes that belong to the
477 same NAT gateway group.
482 <parameter>IPADDR</parameter>
487 <filename>/etc/ctdb/natgw_nodes</filename> when enabled.
493 <term>CTDB_NATGW_PRIVATE_NETWORK=<parameter>IPADDR/MASK</parameter></term>
496 IPADDR/MASK is the private sub-network that is
497 internally routed via the NAT gateway master node. This
498 is usually the private network that is used for node
508 <term>CTDB_NATGW_PUBLIC_IFACE=<parameter>IFACE</parameter></term>
511 IFACE is the network interface on which the
512 CTDB_NATGW_PUBLIC_IP will be configured.
521 <term>CTDB_NATGW_PUBLIC_IP=<parameter>IPADDR/MASK</parameter></term>
524 IPADDR/MASK indicates the IP address that is used for
525 outgoing traffic (originating from
526 CTDB_NATGW_PRIVATE_NETWORK) on the NAT gateway master
527 node. This <emphasis>must not</emphasis> be a
528 configured public IP address.
537 <term>CTDB_NATGW_SLAVE_ONLY=yes|no</term>
540 When set to "yes" a node can not be a NAT gateway master node.
549 <term>CTDB_NATGW_STATIC_ROUTES=<parameter>IPADDR/MASK[@GATEWAY]</parameter> ...</term>
552 Each IPADDR/MASK identifies a network or host to which
553 NATGW should create a fallback route, instead of
554 creating a single default route. This can be used when
555 there is already a default route, via an interface that
556 can not reach required infrastructure, that overrides
557 the NAT gateway default route.
560 If GATEWAY is specified then the corresponding route on
561 the NATGW master node will be via GATEWAY. Such routes
563 <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is not
564 specified. If GATEWAY is not specified for some
565 networks then routes are only created on the NATGW
566 master node for those networks if
567 <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is
571 This should be used with care to avoid causing traffic
572 to unnecessarily double-hop through the NAT gateway
573 master, even when a node is hosting public IP addresses.
574 Each specified network or host should probably have a
575 corresponding automatically created link route or static
587 <title>Example</title>
589 CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
590 CTDB_NATGW_PRIVATE_NETWORK=192.168.1.0/24
591 CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
592 CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
593 CTDB_NATGW_PUBLIC_IFACE=eth0
597 A variation that ensures that infrastructure (ADS, DNS, ...)
598 directly attached to the public network (10.0.0.0/24) is
599 always reachable would look like this:
602 CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
603 CTDB_NATGW_PRIVATE_NETWORK=192.168.1.0/24
604 CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
605 CTDB_NATGW_PUBLIC_IFACE=eth0
606 CTDB_NATGW_STATIC_ROUTES=10.0.0.0/24
609 Note that <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is
617 <title>POLICY ROUTING</title>
620 A node running CTDB may be a component of a complex network
621 topology. In particular, public addresses may be spread
622 across several different networks (or VLANs) and it may not be
623 possible to route packets from these public addresses via the
624 system's default route. Therefore, CTDB has support for
625 policy routing via the <filename>13.per_ip_routing</filename>
626 eventscript. This allows routing to be specified for packets
627 sourced from each public address. The routes are added and
628 removed as CTDB moves public addresses between nodes.
632 For more information, see the <citetitle>POLICY
633 ROUTING</citetitle> section in
634 <citerefentry><refentrytitle>ctdb</refentrytitle>
635 <manvolnum>7</manvolnum></citerefentry>.
640 <term>CTDB_PER_IP_ROUTING_CONF=<parameter>FILENAME</parameter></term>
643 FILENAME contains elements for constructing the desired
644 routes for each source address.
648 The special FILENAME value
649 <constant>__auto_link_local__</constant> indicates that no
650 configuration file is provided and that CTDB should
651 generate reasonable link-local routes for each public IP
658 <parameter>IPADDR</parameter> <parameter>DEST-IPADDR/MASK</parameter> <optional><parameter>GATEWAY-IPADDR</parameter></optional>
664 <filename>/etc/ctdb/policy_routing</filename> when enabled.
670 <term>CTDB_PER_IP_ROUTING_RULE_PREF=<parameter>NUM</parameter></term>
673 NUM sets the priority (or preference) for the routing
674 rules that are added by CTDB.
678 This should be (strictly) greater than 0 and (strictly)
679 less than 32766. A priority of 100 is recommended, unless
680 this conflicts with a priority already in use on the
682 <citerefentry><refentrytitle>ip</refentrytitle>
683 <manvolnum>8</manvolnum></citerefentry>, for more details.
690 CTDB_PER_IP_ROUTING_TABLE_ID_LOW=<parameter>LOW-NUM</parameter>,
691 CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=<parameter>HIGH-NUM</parameter>
695 CTDB determines a unique routing table number to use for
696 the routing related to each public address. LOW-NUM and
697 HIGH-NUM indicate the minimum and maximum routing table
698 numbers that are used.
702 <citerefentry><refentrytitle>ip</refentrytitle>
703 <manvolnum>8</manvolnum></citerefentry> uses some
704 reserved routing table numbers below 255. Therefore,
705 CTDB_PER_IP_ROUTING_TABLE_ID_LOW should be (strictly)
710 CTDB uses the standard file
711 <filename>/etc/iproute2/rt_tables</filename> to maintain
712 a mapping between the routing table numbers and labels.
713 The label for a public address
714 <replaceable>ADDR</replaceable> will look like
715 ctdb.<replaceable>addr</replaceable>. This means that
716 the associated rules and routes are easy to read (and
721 No default, usually 1000 and 9000.
728 <title>Example</title>
730 CTDB_PER_IP_ROUTING_CONF=/etc/ctdb/policy_routing
731 CTDB_PER_IP_ROUTING_RULE_PREF=100
732 CTDB_PER_IP_ROUTING_TABLE_ID_LOW=1000
733 CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
740 <title>MISCELLANEOUS NETWORK CONFIGURATION</title>
745 <term>CTDB_PARTIALLY_ONLINE_INTERFACES=yes|no</term>
748 Whether one or more offline interfaces should cause a
749 monitor event to fail if there are other interfaces that
750 are up. If this is "yes" and a node has some interfaces
751 that are down then <command>ctdb status</command> will
752 display the node as "PARTIALLYONLINE".
767 <title>SERVICE CONFIGURATION</title>
770 CTDB can be configured to manage and/or monitor various NAS (and
771 other) services via its eventscripts.
775 In the simplest case CTDB will manage a service. This means the
776 service will be started and stopped along with CTDB, CTDB will
777 monitor the service and CTDB will do any required
778 reconfiguration of the service when public IP addresses are
786 <title>Eventscripts</title>
789 <member><filename>49.winbind</filename></member>
790 <member><filename>50.samba</filename></member>
797 <term>CTDB_MANAGES_SAMBA=yes|no</term>
800 Should CTDB manage Samba?
809 <term>CTDB_MANAGES_WINBIND=yes|no</term>
812 Should CTDB manage Winbind?
821 <term>CTDB_SAMBA_CHECK_PORTS=<parameter>PORT-LIST</parameter></term>
824 When monitoring Samba, check TCP ports in
825 space-separated PORT-LIST.
828 Default is to monitor ports that Samba is configured to listen on.
834 <term>CTDB_SAMBA_SKIP_SHARE_CHECK=yes|no</term>
837 As part of monitoring, should CTDB skip the check for
838 the existence of each directory configured as share in
839 Samba. This may be desirable if there is a large number
849 <term>CTDB_SERVICE_NMB=<parameter>SERVICE</parameter></term>
852 Distribution specific SERVICE for managing nmbd.
855 Default is distribution-dependant.
860 <term>CTDB_SERVICE_SMB=<parameter>SERVICE</parameter></term>
863 Distribution specific SERVICE for managing smbd.
866 Default is distribution-dependant.
872 <term>CTDB_SERVICE_WINBIND=<parameter>SERVICE</parameter></term>
875 Distribution specific SERVICE for managing winbindd.
878 Default is "winbind".
891 This includes parameters for the kernel NFS server and the
893 <ulink url="https://github.com/nfs-ganesha/nfs-ganesha/wiki">NFS-Ganesha</ulink>
898 <title>Eventscripts</title>
901 <member><filename>60.nfs</filename></member>
902 <member><filename>60.ganesha</filename></member>
909 <term>CTDB_CLUSTER_FILESYSTEM_TYPE=gpfs</term>
912 The type of cluster filesystem to use with NFS-ganesha.
913 Currently only "gpfs" is supported.
922 <term>CTDB_MANAGES_NFS=yes|no</term>
925 Should CTDB manage NFS?
934 <term>CTDB_MONITOR_NFS_THREAD_COUNT=yes|no</term>
937 Whether to monitor the NFS kernel server thread count.
940 This works around a limitation in some NFS initscripts
941 where some threads can be stuck in host filesystem calls
942 (perhaps due to slow storage), a restart occurs, some
943 threads don't exit, the start only adds the missing
944 number of threads, the stuck threads exit, and the
945 result is a lower than expected thread count. Note that
946 if you must also set <varname>RPCNFSDCOUNT</varname>
947 (RedHat/Debian) or <varname>USE_KERNEL_NFSD_NUMBER</varname>
948 (SUSE) in your NFS configuration so the monitoring code
949 knows how many threads there should be - if neither of
950 these are set then this option will be ignored.
959 <term>CTDB_NFS_DUMP_STUCK_THREADS=<parameter>NUM</parameter></term>
962 NUM is the number of NFS kernel server threads to dump
963 stack traces for if some are still alive after stopping
964 NFS during a restart.
967 Default is 5. Set this to 0 to disable this feature.
973 <term>CTDB_NFS_SERVER_MODE=kernel|ganesha</term>
976 Selects which NFS server to be managed.
979 This replaces the deprecated variable
980 <varname>NFS_SERVER_MODE</varname>.
989 <term>CTDB_NFS_SKIP_KNFSD_ALIVE_CHECK=yes|no</term>
992 During monitoring, should CTDB skip the
993 <command>rpcinfo</command> check that is used to see if
994 the NFS kernel server is functional.
1003 <term>CTDB_NFS_SKIP_SHARE_CHECK=yes|no</term>
1006 As part of monitoring, should CTDB skip the check for
1007 the existence of each directory exported via NFS. This
1008 may be desirable if there is a large number of exports.
1017 <term>CTDB_RPCINFO_LOCALHOST=<parameter>IPADDR</parameter>|<parameter>HOSTNAME</parameter></term>
1020 IPADDR or HOSTNAME indicates the address that
1021 <command>rpcinfo</command> should connect to when doing
1022 <command>rpcinfo</command> check on RPC service during
1023 monitoring. Optimally this would be "localhost".
1024 However, this can add some performance overheads.
1027 Default is "127.0.0.1".
1033 <term>CTDB_SKIP_GANESHA_NFSD_CHECK=yes|no</term>
1036 As part of monitoring, should CTDB skip the check for
1037 the existence of each directory exported via
1038 NFS-Ganesha. This may be desirable if there is a large
1052 <title>APACHE HTTPD</title>
1055 CTDB can manage the Apache web server.
1059 <title>Eventscript</title>
1062 <member><filename>41.httpd</filename></member>
1068 <term>CTDB_MANAGES_HTTPD=yes|no</term>
1071 Should CTDB manage the Apache web server?
1082 <title>CLAMAV</title>
1085 CTDB has support to manage the popular anti-virus daemon
1090 <title>Eventscript</title>
1093 <member><filename>31.clamd</filename></member>
1097 This eventscript is not enabled by default. Use
1098 <command>ctdb enablescript</command> to enable it.
1106 <term>CTDB_MANAGES_CLAMD=yes|no</term>
1109 Should CTDB manage ClamAV?
1118 <term>CTDB_CLAMD_SOCKET=<parameter>FILENAME</parameter></term>
1121 FILENAME is the socket to monitor ClamAV.
1134 <title>ISCSI</title>
1137 CTDB has support for managing the Linux iSCSI tgtd service.
1141 <title>Eventscript</title>
1144 <member><filename>70.iscsi</filename></member>
1151 <term>CTDB_MANAGES_ISCSI=yes|no</term>
1154 Should CTDB manage iSCSI tgtd?
1163 <term>CTDB_START_ISCSI_SCRIPTS=<parameter>DIRECTORY</parameter></term>
1166 DIRECTORY on shared storage containing scripts to start
1167 tgtd for each public IP address.
1178 <title>MULTIPATHD</title>
1181 CTDB can monitor multipath devices to ensure that active paths
1186 <title>Eventscript</title>
1189 <member><filename>20.multipathd</filename></member>
1193 This eventscript is not enabled by default. Use
1194 <command>ctdb enablescript</command> to enable it.
1200 <term>CTDB_MONITOR_MPDEVICES=<parameter>MP-DEVICE-LIST</parameter></term>
1203 MP-DEVICE-LIST is a list of multipath devices for CTDB to monitor?
1214 <title>VSFTPD</title>
1217 CTDB can manage the vsftpd FTP server.
1221 <title>Eventscript</title>
1224 <member><filename>40.vsftpd</filename></member>
1230 <term>CTDB_MANAGES_VSFTPD=yes|no</term>
1233 Should CTDB manage the vsftpd FTP server?
1245 SYSTEM RESOURCE MONITORING CONFIGURATION
1249 CTDB can experience seemingly random (performance and other)
1250 issues if system resources become too contrained. Options in
1251 this section can be enabled to allow certain system resources to
1256 <title>Eventscripts</title>
1259 <member><filename>00.ctdb</filename></member>
1260 <member><filename>40.fs_use</filename></member>
1264 Filesystem usage monitoring is in
1265 <filename>40.fs_use</filename>. This eventscript is not
1266 enabled by default. Use <command>ctdb
1267 enablescript</command> to enable it.
1274 <term>CTDB_CHECK_FS_USE=<parameter>FS-LIMIT-LIST</parameter></term>
1277 FS-LIMIT-LIST is a space-separated list of
1278 <parameter>FILESYSTEM</parameter>:<parameter>LIMIT</parameter>
1279 pairs indicating that a node should be flagged unhealthy
1280 if the space used on FILESYSTEM reaches LIMIT%.
1288 Note that this feature uses the
1289 <filename>40.fs_use</filename> eventscript, which is not
1290 enabled by default. Use <command>ctdb
1291 enablescript</command> to enable it.
1297 <term>CTDB_CHECK_SWAP_IS_NOT_USED=yes|no</term>
1300 Should a warning be logged if swap space is in use.
1309 <term>CTDB_MONITOR_FREE_MEMORY=<parameter>NUM</parameter></term>
1312 NUM is a lower limit on available system memory, expressed
1313 in megabytes. If this is set and the amount of available
1314 memory falls below this limit then some debug information
1315 will be logged, the node will be disabled and then CTDB
1325 <term>CTDB_MONITOR_FREE_MEMORY_WARN=<parameter>NUM</parameter></term>
1328 NUM is a lower limit on available system memory, expressed
1329 in megabytes. If this is set and the amount of available
1330 memory falls below this limit then a warning will be
1343 <title>MISCELLANEOUS SERVICE-RELATED CONFIGURATION</title>
1348 <term>CTDB_MANAGED_SERVICES=<parameter>SERVICE-LIST</parameter></term>
1351 SERVICE-LIST is a space-separated list of SERVICEs that
1352 CTDB should manage. This can be used as an alternative
1354 <varname>CTDB_MANAGES_<replaceable>SERVICE</replaceable></varname>
1364 <term>CTDB_SERVICE_AUTOSTARTSTOP=yes|no</term>
1367 When CTDB should start and stop services if they become
1368 managed or unmanaged.
1384 TUNABLES CONFIGURATION
1389 <citerefentry><refentrytitle>ctdbd-tunables</refentrytitle>
1390 <manvolnum>7</manvolnum></citerefentry>) can be set from the
1391 configuration file. They are set as follows:
1394 CTDB_SET_<replaceable>TUNABLE</replaceable>=<replaceable>VALUE</replaceable>
1401 <screen format="linespecific">
1402 CTDB_SET_MonitorInterval=20
1413 Variable in this section are for debugging and testing CTDB.
1414 They should not generally be needed.
1420 <term>CTDB_DEBUG_HUNG_SCRIPT=<parameter>FILENAME</parameter></term>
1423 FILENAME is a script to run to log debug information when
1424 an event script times out.
1427 Default is <filename><varname>CTDB_BASE</varname>/debug-hung-script.sh</filename>.
1433 <term>CTDB_DEBUG_HUNG_SCRIPT_LOGFILE=<parameter>FILENAME</parameter></term>
1436 FILENAME specifies where log messages should go when
1437 debugging hung eventscripts. This is a testing option.
1438 See also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
1441 No default. Messages go to stdout/stderr and are logged
1442 to the same place as other CTDB log messages.
1448 <term>CTDB_DEBUG_HUNG_SCRIPT_STACKPAT=<parameter>REGEXP</parameter></term>
1451 REGEXP specifies interesting processes for which stack
1452 traces should be logged when debugging hung eventscripts
1453 and those processes are matched in pstree output. See
1454 also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
1457 Default is "exportfs\|rpcinfo".
1463 <term>CTDB_DEBUG_LOCKS=<parameter>FILENAME</parameter></term>
1466 FILENAME is a script to run to log debug information when
1467 an CTDB fails to freeze databases during recovery.
1471 <filename><varname>CTDB_BASE</varname>/debug_locks.sh</filename>.
1477 <term>CTDB_ETCDIR=<parameter>DIRECTORY</parameter></term>
1480 DIRECTORY containing system configuration files. This is
1481 used to provide alternate configuration when testing and
1482 should not need to be changed from the default.
1485 Default is <filename>/etc</filename>.
1491 <term>CTDB_INIT_STYLE=debian|redhat|suse</term>
1494 This is the init style used by the Linux distribution (or
1495 other operating system) being used. This is usually
1496 determined dynamically by checking the system. This
1497 variable is used by the initscript to determine which init
1498 system primitives to use. It is also used by some
1499 eventscripts to choose the name of initscripts for certain
1500 services, since these can vary between distributions.
1506 If this option needs to be changed from the calculated
1507 default for the initscript to function properly, then it
1508 must be set in the distribution-specific initscript
1509 configuration, such as
1510 <filename>/etc/sysconfig/ctdb</filename>
1516 <term>CTDB_MAX_CORRUPT_DB_BACKUPS=<parameter>NUM</parameter></term>
1519 NUM is the maximum number of volatile TDB database backups
1520 to be kept (for each database) when a corrupt database is
1521 found during startup. Volatile TDBs are zeroed during
1522 startup so backups are needed to debug any corruption that
1523 occurs before a restart.
1532 <term>CTDB_RC_LOCAL=<parameter>FILENAME</parameter></term>
1535 FILENAME is a script fragment to be sourced by the
1536 <filename>functions</filename> that is sourced by scripts.
1537 On example use would be to override function definitions
1538 in unit tests. As a sanity check, this file must be
1539 executable for it to be used.
1548 <term>CTDB_RUN_TIMEOUT_MONITOR=yes|no</term>
1551 Whether CTDB should simulate timing out monitor events.
1552 This uses the <filename>99.timeout</filename> eventscript.
1561 <term>CTDB_SCRIPT_DEBUGLEVEL=<parameter>NUM</parameter></term>
1564 NUM is the level debugging messages printed by CTDB
1565 scripts. Setting this to a higher number (e.g. 4) will
1566 cause some scripts to log more messages.
1575 <term>CTDB_SUPPRESS_COREFILE=yes|no</term>
1578 Whether CTDB core files should be suppressed.
1587 <term>CTDB_VALGRIND=yes|no|<parameter>COMMAND</parameter></term>
1590 If "yes", this causes
1591 <citerefentry><refentrytitle>ctdbd</refentrytitle>
1592 <manvolnum>1</manvolnum></citerefentry> to be run under
1593 <citerefentry><refentrytitle>valgrind</refentrytitle>
1594 <manvolnum>1</manvolnum></citerefentry> with logs going to
1595 <filename>/var/log/ctdb_valgrind</filename>. If neither
1596 "yes" nor "no" then the value is assumed to be a COMMAND
1597 (e.g. a <command>valgrind</command> variation, a
1598 <citerefentry><refentrytitle>gdb</refentrytitle>
1599 <manvolnum>1</manvolnum></citerefentry> command) that is
1600 used in place of the default <command>valgrind</command>
1601 command. In either case, the <option>--valgrind</option>
1602 option is passed to <command>ctdbd</command>.
1616 <title>FILES</title>
1619 <member><filename>/etc/ctdb/ctdbd.conf</filename></member>
1620 <member><filename>/etc/sysconfig/ctdb</filename></member>
1621 <member><filename>/etc/default/ctdb</filename></member>
1622 <member><filename>/etc/ctdb/sysconfig/ctdb</filename></member>
1627 <title>SEE ALSO</title>
1629 <citerefentry><refentrytitle>ctdbd</refentrytitle>
1630 <manvolnum>1</manvolnum></citerefentry>,
1632 <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
1633 <manvolnum>1</manvolnum></citerefentry>,
1635 <citerefentry><refentrytitle>onnode</refentrytitle>
1636 <manvolnum>1</manvolnum></citerefentry>,
1638 <citerefentry><refentrytitle>ctdb</refentrytitle>
1639 <manvolnum>7</manvolnum></citerefentry>,
1641 <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
1642 <manvolnum>7</manvolnum></citerefentry>,
1644 <ulink url="http://ctdb.samba.org/"/>
1651 This documentation was written by
1659 <holder>Andrew Tridgell</holder>
1660 <holder>Ronnie Sahlberg</holder>
1664 This program is free software; you can redistribute it and/or
1665 modify it under the terms of the GNU General Public License as
1666 published by the Free Software Foundation; either version 3 of
1667 the License, or (at your option) any later version.
1670 This program is distributed in the hope that it will be
1671 useful, but WITHOUT ANY WARRANTY; without even the implied
1672 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
1673 PURPOSE. See the GNU General Public License for more details.
1676 You should have received a copy of the GNU General Public
1677 License along with this program; if not, see
1678 <ulink url="http://www.gnu.org/licenses"/>.