| blob | 9d545b5cc0d5b070aabacee70fda814510fe5d7f |
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="ctdb-script.options.5">
8 <refmeta>
9 <refentrytitle>ctdb-script.options</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>ctdb-script.options</refname>
17 <refpurpose>CTDB scripts configuration files</refpurpose>
18 </refnamediv>
20 <refsect1>
21 <title>DESCRIPTION</title>
23 <para>
24 Each CTDB script has 2 possible locations for its configuration options:
25 </para>
27 <variablelist>
29 <varlistentry>
30 <term>
31 <filename>/usr/local/etc/ctdb/script.options</filename>
32 </term>
33 <listitem>
34 <para>
35 This is a catch-all global file for general purpose
36 scripts and for options that are used in multiple event
37 scripts.
38 </para>
39 </listitem>
40 </varlistentry>
42 <varlistentry>
43 <term>
44 <parameter>SCRIPT</parameter>.options
45 </term>
46 <listitem>
47 <para>
48 That is, options for
49 <filename><parameter>SCRIPT</parameter></filename> are
50 placed in a file alongside the script, with a ".script"
51 suffix added. This style is usually recommended for event
52 scripts.
53 </para>
55 <para>
56 Options in this script-specific file override those in
57 the global file.
58 </para>
59 </listitem>
60 </varlistentry>
62 </variablelist>
64 <para>
65 These files should include simple shell-style variable
66 assignments and shell-style comments.
67 </para>
69 </refsect1>
71 <refsect1>
72 <title>NETWORK CONFIGURATION</title>
74 <refsect2>
75 <title>10.interface</title>
77 <para>
78 This event script handles monitoring of interfaces using by
79 public IP addresses.
80 </para>
82 <variablelist>
84 <varlistentry>
85 <term>
86 CTDB_PARTIALLY_ONLINE_INTERFACES=yes|no
87 </term>
88 <listitem>
89 <para>
90 Whether one or more offline interfaces should cause a
91 monitor event to fail if there are other interfaces that
92 are up. If this is "yes" and a node has some interfaces
93 that are down then <command>ctdb status</command> will
94 display the node as "PARTIALLYONLINE".
95 </para>
97 <para>
98 Note that CTDB_PARTIALLY_ONLINE_INTERFACES=yes is not
99 generally compatible with NAT gateway or LVS. NAT
100 gateway relies on the interface configured by
101 CTDB_NATGW_PUBLIC_IFACE to be up and LVS replies on
102 CTDB_LVS_PUBLIC_IFACE to be up. CTDB does not check if
103 these options are set in an incompatible way so care is
104 needed to understand the interaction.
105 </para>
107 <para>
108 Default is "no".
109 </para>
110 </listitem>
111 </varlistentry>
113 </variablelist>
114 </refsect2>
116 <refsect2>
117 <title>11.natgw</title>
119 <para>
120 Provides CTDB's NAT gateway functionality.
121 </para>
123 <para>
124 NAT gateway is used to configure fallback routing for nodes
125 when they do not host any public IP addresses. For example,
126 it allows unhealthy nodes to reliably communicate with
127 external infrastructure. One node in a NAT gateway group will
128 be designated as the NAT gateway master node and other (slave)
129 nodes will be configured with fallback routes via the NAT
130 gateway master node. For more information, see the
131 <citetitle>NAT GATEWAY</citetitle> section in
132 <citerefentry><refentrytitle>ctdb</refentrytitle>
133 <manvolnum>7</manvolnum></citerefentry>.
134 </para>
136 <variablelist>
138 <varlistentry>
139 <term>CTDB_NATGW_DEFAULT_GATEWAY=<parameter>IPADDR</parameter></term>
140 <listitem>
141 <para>
142 IPADDR is an alternate network gateway to use on the NAT
143 gateway master node. If set, a fallback default route
144 is added via this network gateway.
145 </para>
146 <para>
147 No default. Setting this variable is optional - if not
148 set that no route is created on the NAT gateway master
149 node.
150 </para>
151 </listitem>
152 </varlistentry>
154 <varlistentry>
155 <term>CTDB_NATGW_NODES=<parameter>FILENAME</parameter></term>
156 <listitem>
157 <para>
158 FILENAME contains the list of nodes that belong to the
159 same NAT gateway group.
160 </para>
161 <para>
162 File format:
163 <screen>
164 <parameter>IPADDR</parameter> <optional>slave-only</optional>
165 </screen>
166 </para>
167 <para>
168 IPADDR is the private IP address of each node in the NAT
169 gateway group.
170 </para>
171 <para>
172 If "slave-only" is specified then the corresponding node
173 can not be the NAT gateway master node. In this case
174 <varname>CTDB_NATGW_PUBLIC_IFACE</varname> and
175 <varname>CTDB_NATGW_PUBLIC_IP</varname> are optional and
176 unused.
177 </para>
178 <para>
179 No default, usually
180 <filename>/usr/local/etc/ctdb/natgw_nodes</filename> when enabled.
181 </para>
182 </listitem>
183 </varlistentry>
185 <varlistentry>
186 <term>CTDB_NATGW_PRIVATE_NETWORK=<parameter>IPADDR/MASK</parameter></term>
187 <listitem>
188 <para>
189 IPADDR/MASK is the private sub-network that is
190 internally routed via the NAT gateway master node. This
191 is usually the private network that is used for node
192 addresses.
193 </para>
194 <para>
195 No default.
196 </para>
197 </listitem>
198 </varlistentry>
200 <varlistentry>
201 <term>CTDB_NATGW_PUBLIC_IFACE=<parameter>IFACE</parameter></term>
202 <listitem>
203 <para>
204 IFACE is the network interface on which the
205 CTDB_NATGW_PUBLIC_IP will be configured.
206 </para>
207 <para>
208 No default.
209 </para>
210 </listitem>
211 </varlistentry>
213 <varlistentry>
214 <term>CTDB_NATGW_PUBLIC_IP=<parameter>IPADDR/MASK</parameter></term>
215 <listitem>
216 <para>
217 IPADDR/MASK indicates the IP address that is used for
218 outgoing traffic (originating from
219 CTDB_NATGW_PRIVATE_NETWORK) on the NAT gateway master
220 node. This <emphasis>must not</emphasis> be a
221 configured public IP address.
222 </para>
223 <para>
224 No default.
225 </para>
226 </listitem>
227 </varlistentry>
229 <varlistentry>
230 <term>CTDB_NATGW_STATIC_ROUTES=<parameter>IPADDR/MASK[@GATEWAY]</parameter> ...</term>
231 <listitem>
232 <para>
233 Each IPADDR/MASK identifies a network or host to which
234 NATGW should create a fallback route, instead of
235 creating a single default route. This can be used when
236 there is already a default route, via an interface that
237 can not reach required infrastructure, that overrides
238 the NAT gateway default route.
239 </para>
240 <para>
241 If GATEWAY is specified then the corresponding route on
242 the NATGW master node will be via GATEWAY. Such routes
243 are created even if
244 <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is not
245 specified. If GATEWAY is not specified for some
246 networks then routes are only created on the NATGW
247 master node for those networks if
248 <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is
249 specified.
250 </para>
251 <para>
252 This should be used with care to avoid causing traffic
253 to unnecessarily double-hop through the NAT gateway
254 master, even when a node is hosting public IP addresses.
255 Each specified network or host should probably have a
256 corresponding automatically created link route or static
257 route to avoid this.
258 </para>
259 <para>
260 No default.
261 </para>
262 </listitem>
263 </varlistentry>
265 </variablelist>
267 <refsect3>
268 <title>Example</title>
269 <screen>
270 CTDB_NATGW_NODES=/usr/local/etc/ctdb/natgw_nodes
271 CTDB_NATGW_PRIVATE_NETWORK=192.168.1.0/24
272 CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
273 CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
274 CTDB_NATGW_PUBLIC_IFACE=eth0
275 </screen>
277 <para>
278 A variation that ensures that infrastructure (ADS, DNS, ...)
279 directly attached to the public network (10.0.0.0/24) is
280 always reachable would look like this:
281 </para>
282 <screen>
283 CTDB_NATGW_NODES=/usr/local/etc/ctdb/natgw_nodes
284 CTDB_NATGW_PRIVATE_NETWORK=192.168.1.0/24
285 CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
286 CTDB_NATGW_PUBLIC_IFACE=eth0
287 CTDB_NATGW_STATIC_ROUTES=10.0.0.0/24
288 </screen>
289 <para>
290 Note that <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is
291 not specified.
292 </para>
293 </refsect3>
295 </refsect2>
297 <refsect2>
298 <title>13.per_ip_routing</title>
300 <para>
301 Provides CTDB's policy routing functionality.
302 </para>
304 <para>
305 A node running CTDB may be a component of a complex network
306 topology. In particular, public addresses may be spread
307 across several different networks (or VLANs) and it may not be
308 possible to route packets from these public addresses via the
309 system's default route. Therefore, CTDB has support for
310 policy routing via the <filename>13.per_ip_routing</filename>
311 eventscript. This allows routing to be specified for packets
312 sourced from each public address. The routes are added and
313 removed as CTDB moves public addresses between nodes.
314 </para>
316 <para>
317 For more information, see the <citetitle>POLICY
318 ROUTING</citetitle> section in
319 <citerefentry><refentrytitle>ctdb</refentrytitle>
320 <manvolnum>7</manvolnum></citerefentry>.
321 </para>
323 <variablelist>
324 <varlistentry>
325 <term>CTDB_PER_IP_ROUTING_CONF=<parameter>FILENAME</parameter></term>
326 <listitem>
327 <para>
328 FILENAME contains elements for constructing the desired
329 routes for each source address.
330 </para>
332 <para>
333 The special FILENAME value
334 <constant>__auto_link_local__</constant> indicates that no
335 configuration file is provided and that CTDB should
336 generate reasonable link-local routes for each public IP
337 address.
338 </para>
340 <para>
341 File format:
342 <screen>
343 <parameter>IPADDR</parameter> <parameter>DEST-IPADDR/MASK</parameter> <optional><parameter>GATEWAY-IPADDR</parameter></optional>
344 </screen>
345 </para>
347 <para>
348 No default, usually
349 <filename>/usr/local/etc/ctdb/policy_routing</filename>
350 when enabled.
351 </para>
352 </listitem>
353 </varlistentry>
355 <varlistentry>
356 <term>
357 CTDB_PER_IP_ROUTING_RULE_PREF=<parameter>NUM</parameter>
358 </term>
359 <listitem>
360 <para>
361 NUM sets the priority (or preference) for the routing
362 rules that are added by CTDB.
363 </para>
365 <para>
366 This should be (strictly) greater than 0 and (strictly)
367 less than 32766. A priority of 100 is recommended, unless
368 this conflicts with a priority already in use on the
369 system. See
370 <citerefentry><refentrytitle>ip</refentrytitle>
371 <manvolnum>8</manvolnum></citerefentry>, for more details.
372 </para>
373 </listitem>
374 </varlistentry>
376 <varlistentry>
377 <term>
378 CTDB_PER_IP_ROUTING_TABLE_ID_LOW=<parameter>LOW-NUM</parameter>,
379 CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=<parameter>HIGH-NUM</parameter>
380 </term>
381 <listitem>
382 <para>
383 CTDB determines a unique routing table number to use for
384 the routing related to each public address. LOW-NUM and
385 HIGH-NUM indicate the minimum and maximum routing table
386 numbers that are used.
387 </para>
389 <para>
390 <citerefentry><refentrytitle>ip</refentrytitle>
391 <manvolnum>8</manvolnum></citerefentry> uses some
392 reserved routing table numbers below 255. Therefore,
393 CTDB_PER_IP_ROUTING_TABLE_ID_LOW should be (strictly)
394 greater than 255.
395 </para>
397 <para>
398 CTDB uses the standard file
399 <filename>/etc/iproute2/rt_tables</filename> to maintain
400 a mapping between the routing table numbers and labels.
401 The label for a public address
402 <replaceable>ADDR</replaceable> will look like
403 ctdb.<replaceable>addr</replaceable>. This means that
404 the associated rules and routes are easy to read (and
405 manipulate).
406 </para>
408 <para>
409 No default, usually 1000 and 9000.
410 </para>
411 </listitem>
412 </varlistentry>
413 </variablelist>
415 <refsect3>
416 <title>Example</title>
417 <screen>
418 CTDB_PER_IP_ROUTING_CONF=/usr/local/etc/ctdb/policy_routing
419 CTDB_PER_IP_ROUTING_RULE_PREF=100
420 CTDB_PER_IP_ROUTING_TABLE_ID_LOW=1000
421 CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
422 </screen>
423 </refsect3>
425 </refsect2>
427 <refsect2>
428 <title>91.lvs</title>
430 <para>
431 Provides CTDB's LVS functionality.
432 </para>
434 <para>
435 For a general description see the <citetitle>LVS</citetitle>
436 section in <citerefentry><refentrytitle>ctdb</refentrytitle>
437 <manvolnum>7</manvolnum></citerefentry>.
438 </para>
440 <variablelist>
442 <varlistentry>
443 <term>
444 CTDB_LVS_NODES=<parameter>FILENAME</parameter>
445 </term>
446 <listitem>
447 <para>
448 FILENAME contains the list of nodes that belong to the
449 same LVS group.
450 </para>
451 <para>
452 File format:
453 <screen>
454 <parameter>IPADDR</parameter> <optional>slave-only</optional>
455 </screen>
456 </para>
457 <para>
458 IPADDR is the private IP address of each node in the LVS
459 group.
460 </para>
461 <para>
462 If "slave-only" is specified then the corresponding node
463 can not be the LVS master node. In this case
464 <varname>CTDB_LVS_PUBLIC_IFACE</varname> and
465 <varname>CTDB_LVS_PUBLIC_IP</varname> are optional and
466 unused.
467 </para>
468 <para>
469 No default, usually
470 <filename>/usr/local/etc/ctdb/lvs_nodes</filename> when enabled.
471 </para>
472 </listitem>
473 </varlistentry>
475 <varlistentry>
476 <term>
477 CTDB_LVS_PUBLIC_IFACE=<parameter>INTERFACE</parameter>
478 </term>
479 <listitem>
480 <para>
481 INTERFACE is the network interface that clients will use
482 to connection to <varname>CTDB_LVS_PUBLIC_IP</varname>.
483 This is optional for slave-only nodes.
484 No default.
485 </para>
486 </listitem>
487 </varlistentry>
489 <varlistentry>
490 <term>
491 CTDB_LVS_PUBLIC_IP=<parameter>IPADDR</parameter>
492 </term>
493 <listitem>
494 <para>
495 CTDB_LVS_PUBLIC_IP is the LVS public address. No
496 default.
497 </para>
498 </listitem>
499 </varlistentry>
501 </variablelist>
502 </refsect2>
504 </refsect1>
506 <refsect1>
507 <title>SERVICE CONFIGURATION</title>
509 <para>
510 CTDB can be configured to manage and/or monitor various NAS (and
511 other) services via its eventscripts.
512 </para>
514 <para>
515 In the simplest case CTDB will manage a service. This means the
516 service will be started and stopped along with CTDB, CTDB will
517 monitor the service and CTDB will do any required
518 reconfiguration of the service when public IP addresses are
519 failed over.
520 </para>
522 <refsect2>
523 <title>20.multipathd</title>
525 <para>
526 Provides CTDB's Linux multipathd service management.
527 </para>
529 <para>
530 It can monitor multipath devices to ensure that active paths
531 are available.
532 </para>
534 <variablelist>
535 <varlistentry>
536 <term>
537 CTDB_MONITOR_MPDEVICES=<parameter>MP-DEVICE-LIST</parameter>
538 </term>
539 <listitem>
540 <para>
541 MP-DEVICE-LIST is a list of multipath devices for CTDB to monitor?
542 </para>
543 <para>
544 No default.
545 </para>
546 </listitem>
547 </varlistentry>
548 </variablelist>
549 </refsect2>
551 <refsect2>
552 <title>31.clamd</title>
554 <para>
555 This event script provide CTDB's ClamAV anti-virus service
556 management.
557 </para>
559 <para>
560 This eventscript is not enabled by default. Use <command>ctdb
561 enablescript</command> to enable it.
562 </para>
564 <variablelist>
566 <varlistentry>
567 <term>
568 CTDB_CLAMD_SOCKET=<parameter>FILENAME</parameter>
569 </term>
570 <listitem>
571 <para>
572 FILENAME is the socket to monitor ClamAV.
573 </para>
574 <para>
575 No default.
576 </para>
577 </listitem>
578 </varlistentry>
580 </variablelist>
582 </refsect2>
584 <refsect2>
585 <title>49.winbind</title>
587 <para>
588 Provides CTDB's Samba winbind service management.
589 </para>
591 <variablelist>
593 <varlistentry>
594 <term>
595 CTDB_SERVICE_WINBIND=<parameter>SERVICE</parameter>
596 </term>
597 <listitem>
598 <para>
599 Distribution specific SERVICE for managing winbindd.
600 </para>
601 <para>
602 Default is "winbind".
603 </para>
604 </listitem>
605 </varlistentry>
607 </variablelist>
609 </refsect2>
611 <refsect2>
612 <title>50.samba</title>
614 <para>
615 Provides the core of CTDB's Samba file service management.
616 </para>
618 <variablelist>
620 <varlistentry>
621 <term>
622 CTDB_SAMBA_CHECK_PORTS=<parameter>PORT-LIST</parameter>
623 </term>
624 <listitem>
625 <para>
626 When monitoring Samba, check TCP ports in
627 space-separated PORT-LIST.
628 </para>
629 <para>
630 Default is to monitor ports that Samba is configured to listen on.
631 </para>
632 </listitem>
633 </varlistentry>
635 <varlistentry>
636 <term>
637 CTDB_SAMBA_SKIP_SHARE_CHECK=yes|no
638 </term>
639 <listitem>
640 <para>
641 As part of monitoring, should CTDB skip the check for
642 the existence of each directory configured as share in
643 Samba. This may be desirable if there is a large number
644 of shares.
645 </para>
646 <para>
647 Default is no.
648 </para>
649 </listitem>
650 </varlistentry>
652 <varlistentry>
653 <term>
654 CTDB_SERVICE_NMB=<parameter>SERVICE</parameter>
655 </term>
656 <listitem>
657 <para>
658 Distribution specific SERVICE for managing nmbd.
659 </para>
660 <para>
661 Default is distribution-dependant.
662 </para>
663 </listitem>
664 </varlistentry>
665 <varlistentry>
666 <term>
667 CTDB_SERVICE_SMB=<parameter>SERVICE</parameter>
668 </term>
669 <listitem>
670 <para>
671 Distribution specific SERVICE for managing smbd.
672 </para>
673 <para>
674 Default is distribution-dependant.
675 </para>
676 </listitem>
677 </varlistentry>
679 </variablelist>
681 </refsect2>
683 <refsect2>
684 <title>60.nfs</title>
686 <para>
687 This event script (along with 06.nfs) provides CTDB's NFS
688 service management.
689 </para>
691 <para>
692 This includes parameters for the kernel NFS server.
693 Alternative NFS subsystems (such as <ulink
694 url="https://github.com/nfs-ganesha/nfs-ganesha/wiki">NFS-Ganesha</ulink>)
695 can be integrated using <varname>CTDB_NFS_CALLOUT</varname>.
696 </para>
698 <variablelist>
700 <varlistentry>
701 <term>
702 CTDB_NFS_CALLOUT=<parameter>COMMAND</parameter>
703 </term>
704 <listitem>
705 <para>
706 COMMAND specifies the path to a callout to handle
707 interactions with the configured NFS system, including
708 startup, shutdown, monitoring.
709 </para>
710 <para>
711 Default is the included
712 <command>nfs-linux-kernel-callout</command>.
713 </para>
714 </listitem>
715 </varlistentry>
717 <varlistentry>
718 <term>
719 CTDB_NFS_CHECKS_DIR=<parameter>DIRECTORY</parameter>
720 </term>
721 <listitem>
722 <para>
723 Specifies the path to a DIRECTORY containing files that
724 describe how to monitor the responsiveness of NFS RPC
725 services. See the README file for this directory for an
726 explanation of the contents of these "check" files.
727 </para>
728 <para>
729 CTDB_NFS_CHECKS_DIR can be used to point to different
730 sets of checks for different NFS servers.
731 </para>
732 <para>
733 One way of using this is to have it point to, say,
734 <filename>/usr/local/etc/ctdb/nfs-checks-enabled.d</filename>
735 and populate it with symbolic links to the desired check
736 files. This avoids duplication and is upgrade-safe.
737 </para>
738 <para>
739 Default is
740 <filename>/usr/local/etc/ctdb/nfs-checks.d</filename>,
741 which contains NFS RPC checks suitable for Linux kernel
742 NFS.
743 </para>
744 </listitem>
745 </varlistentry>
747 <varlistentry>
748 <term>
749 CTDB_NFS_SKIP_SHARE_CHECK=yes|no
750 </term>
751 <listitem>
752 <para>
753 As part of monitoring, should CTDB skip the check for
754 the existence of each directory exported via NFS. This
755 may be desirable if there is a large number of exports.
756 </para>
757 <para>
758 Default is no.
759 </para>
760 </listitem>
761 </varlistentry>
763 <varlistentry>
764 <term>
765 CTDB_RPCINFO_LOCALHOST=<parameter>IPADDR</parameter>|<parameter>HOSTNAME</parameter>
766 </term>
767 <listitem>
768 <para>
769 IPADDR or HOSTNAME indicates the address that
770 <command>rpcinfo</command> should connect to when doing
771 <command>rpcinfo</command> check on IPv4 RPC service during
772 monitoring. Optimally this would be "localhost".
773 However, this can add some performance overheads.
774 </para>
775 <para>
776 Default is "127.0.0.1".
777 </para>
778 </listitem>
779 </varlistentry>
781 <varlistentry>
782 <term>
783 CTDB_RPCINFO_LOCALHOST6=<parameter>IPADDR</parameter>|<parameter>HOSTNAME</parameter>
784 </term>
785 <listitem>
786 <para>
787 IPADDR or HOSTNAME indicates the address that
788 <command>rpcinfo</command> should connect to when doing
789 <command>rpcinfo</command> check on IPv6 RPC service
790 during monitoring. Optimally this would be "localhost6"
791 (or similar). However, this can add some performance
792 overheads.
793 </para>
794 <para>
795 Default is "::1".
796 </para>
797 </listitem>
798 </varlistentry>
800 <varlistentry>
801 <term>
802 CTDB_NFS_STATE_FS_TYPE=<parameter>TYPE</parameter>
803 </term>
804 <listitem>
805 <para>
806 The type of filesystem used for a clustered NFS' shared
807 state. No default.
808 </para>
809 </listitem>
810 </varlistentry>
812 <varlistentry>
813 <term>
814 CTDB_NFS_STATE_MNT=<parameter>DIR</parameter>
815 </term>
816 <listitem>
817 <para>
818 The directory where a clustered NFS' shared state will be
819 located. No default.
820 </para>
821 </listitem>
822 </varlistentry>
824 </variablelist>
826 </refsect2>
828 <refsect2>
829 <title>70.iscsi</title>
831 <para>
832 Provides CTDB's Linux iSCSI tgtd service management.
833 </para>
835 <variablelist>
837 <varlistentry>
838 <term>
839 CTDB_START_ISCSI_SCRIPTS=<parameter>DIRECTORY</parameter>
840 </term>
841 <listitem>
842 <para>
843 DIRECTORY on shared storage containing scripts to start
844 tgtd for each public IP address.
845 </para>
846 <para>
847 No default.
848 </para>
849 </listitem>
850 </varlistentry>
851 </variablelist>
852 </refsect2>
854 </refsect1>
856 <refsect1>
857 <title>
858 DATABASE SETUP
859 </title>
861 <para>
862 CTDB checks the consistency of databases during startup.
863 </para>
865 <refsect2>
866 <title>00.ctdb</title>
868 <variablelist>
870 <varlistentry>
871 <term>CTDB_MAX_CORRUPT_DB_BACKUPS=<parameter>NUM</parameter></term>
872 <listitem>
873 <para>
874 NUM is the maximum number of volatile TDB database
875 backups to be kept (for each database) when a corrupt
876 database is found during startup. Volatile TDBs are
877 zeroed during startup so backups are needed to debug
878 any corruption that occurs before a restart.
879 </para>
880 <para>
881 Default is 10.
882 </para>
883 </listitem>
884 </varlistentry>
886 </variablelist>
887 </refsect2>
889 </refsect1>
891 <refsect1>
892 <title>SYSTEM RESOURCE MONITORING</title>
894 <refsect2>
895 <title>
896 05.system
897 </title>
899 <para>
900 Provides CTDB's filesystem and memory usage monitoring.
901 </para>
903 <para>
904 CTDB can experience seemingly random (performance and other)
905 issues if system resources become too constrained. Options in
906 this section can be enabled to allow certain system resources
907 to be checked. They allows warnings to be logged and nodes to
908 be marked unhealthy when system resource usage reaches the
909 configured thresholds.
910 </para>
912 <para>
913 Some checks are enabled by default. It is recommended that
914 these checks remain enabled or are augmented by extra checks.
915 There is no supported way of completely disabling the checks.
916 </para>
918 <variablelist>
920 <varlistentry>
921 <term>
922 CTDB_MONITOR_FILESYSTEM_USAGE=<parameter>FS-LIMIT-LIST</parameter>
923 </term>
924 <listitem>
925 <para>
926 FS-LIMIT-LIST is a space-separated list of
927 <parameter>FILESYSTEM</parameter>:<parameter>WARN_LIMIT</parameter><optional>:<parameter>UNHEALTHY_LIMIT</parameter></optional>
928 triples indicating that warnings should be logged if the
929 space used on FILESYSTEM reaches WARN_LIMIT%. If usage
930 reaches UNHEALTHY_LIMIT then the node should be flagged
931 unhealthy. Either WARN_LIMIT or UNHEALTHY_LIMIT may be
932 left blank, meaning that check will be omitted.
933 </para>
935 <para>
936 Default is to warn for each filesystem containing a
937 database directory
938 (<literal>volatile database directory</literal>,
939 <literal>persistent database directory</literal>,
940 <literal>state database directory</literal>)
941 with a threshold of 90%.
942 </para>
943 </listitem>
944 </varlistentry>
946 <varlistentry>
947 <term>
948 CTDB_MONITOR_MEMORY_USAGE=<parameter>MEM-LIMITS</parameter>
949 </term>
950 <listitem>
951 <para>
952 MEM-LIMITS takes the form
953 <parameter>WARN_LIMIT</parameter><optional>:<parameter>UNHEALTHY_LIMIT</parameter></optional>
954 indicating that warnings should be logged if memory
955 usage reaches WARN_LIMIT%. If usage reaches
956 UNHEALTHY_LIMIT then the node should be flagged
957 unhealthy. Either WARN_LIMIT or UNHEALTHY_LIMIT may be
958 left blank, meaning that check will be omitted.
959 </para>
960 <para>
961 Default is 80, so warnings will be logged when memory
962 usage reaches 80%.
963 </para>
964 </listitem>
965 </varlistentry>
967 <varlistentry>
968 <term>
969 CTDB_MONITOR_SWAP_USAGE=<parameter>SWAP-LIMITS</parameter>
970 </term>
971 <listitem>
972 <para>
973 SWAP-LIMITS takes the form
974 <parameter>WARN_LIMIT</parameter><optional>:<parameter>UNHEALTHY_LIMIT</parameter></optional>
975 indicating that warnings should be logged if
976 swap usage reaches WARN_LIMIT%. If usage reaches
977 UNHEALTHY_LIMIT then the node should be flagged
978 unhealthy. Either WARN_LIMIT or UNHEALTHY_LIMIT may be
979 left blank, meaning that check will be omitted.
980 </para>
981 <para>
982 Default is 25, so warnings will be logged when swap
983 usage reaches 25%.
984 </para>
985 </listitem>
986 </varlistentry>
988 </variablelist>
989 </refsect2>
991 </refsect1>
994 <refsect1>
995 <title>EVENT SCRIPT DEBUGGING</title>
997 <refsect2>
998 <title>
999 debug-hung-script.sh
1000 </title>
1002 <variablelist>
1004 <varlistentry>
1005 <term>CTDB_DEBUG_HUNG_SCRIPT_STACKPAT=<parameter>REGEXP</parameter></term>
1006 <listitem>
1007 <para>
1008 REGEXP specifies interesting processes for which stack
1009 traces should be logged when debugging hung eventscripts
1010 and those processes are matched in pstree output.
1011 REGEXP is an extended regexp so choices are separated by
1012 pipes ('|'). However, REGEXP should not contain
1013 parentheses. See also the <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
1014 <manvolnum>5</manvolnum></citerefentry>
1015 [event] "debug script" option.
1016 </para>
1017 <para>
1018 Default is "exportfs|rpcinfo".
1019 </para>
1020 </listitem>
1021 </varlistentry>
1023 </variablelist>
1024 </refsect2>
1026 </refsect1>
1028 <refsect1>
1029 <title>FILES</title>
1031 <simplelist>
1032 <member><filename>/usr/local/etc/ctdb/script.options</filename></member>
1033 </simplelist>
1034 </refsect1>
1036 <refsect1>
1037 <title>SEE ALSO</title>
1038 <para>
1039 <citerefentry><refentrytitle>ctdbd</refentrytitle>
1040 <manvolnum>1</manvolnum></citerefentry>,
1042 <citerefentry><refentrytitle>ctdb</refentrytitle>
1043 <manvolnum>7</manvolnum></citerefentry>,
1045 <ulink url="http://ctdb.samba.org/"/>
1046 </para>
1047 </refsect1>
1049 <refentryinfo>
1050 <author>
1051 <contrib>
1052 This documentation was written by
1053 Amitay Isaacs,
1054 Martin Schwenke
1055 </contrib>
1056 </author>
1058 <copyright>
1059 <year>2007</year>
1060 <holder>Andrew Tridgell</holder>
1061 <holder>Ronnie Sahlberg</holder>
1062 </copyright>
1063 <legalnotice>
1064 <para>
1065 This program is free software; you can redistribute it and/or
1066 modify it under the terms of the GNU General Public License as
1067 published by the Free Software Foundation; either version 3 of
1068 the License, or (at your option) any later version.
1069 </para>
1070 <para>
1071 This program is distributed in the hope that it will be
1072 useful, but WITHOUT ANY WARRANTY; without even the implied
1073 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
1074 PURPOSE. See the GNU General Public License for more details.
1075 </para>
1076 <para>
1077 You should have received a copy of the GNU General Public
1078 License along with this program; if not, see
1079 <ulink url="http://www.gnu.org/licenses"/>.
1080 </para>
1081 </legalnotice>
1082 </refentryinfo>
1084 </refentry>