ctdb/doc/ctdbd.conf.5.xml

   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">
   5
   6 <refentry id="ctdbd.conf.5">
   7
   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>
  14
  15   <refnamediv>
  16     <refname>ctdbd.conf</refname>
  17     <refpurpose>CTDB daemon configuration file</refpurpose>
  18   </refnamediv>
  19
  20   <refsect1>
  21     <title>DESCRIPTION</title>
  22
  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>
  28
  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>
  35
  36     <para>
  37       CTDB configuration variables are grouped into several categories below.
  38     </para>
  39
  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>
  50
  51   </refsect1>
  52
  53   <refsect1>
  54     <title>
  55       INITSCRIPT CONFIGURATION
  56     </title>
  57
  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>
  64
  65     <variablelist>
  66
  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>
  77
  78           <para>
  79             Default is <filename>/var/run/ctdb/ctdbd.pid</filename>.
  80             Corresponds to <option>--pidfile</option>.
  81           </para>
  82         </listitem>
  83       </varlistentry>
  84
  85     </variablelist>
  86   </refsect1>
  87
  88   <refsect1>
  89     <title>
  90       GLOBAL CONFIGURATION
  91     </title>
  92
  93     <para>
  94       These options may be used in the initscripts, daemon and
  95       scripts.
  96     </para>
  97
  98     <variablelist>
  99
 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>
 108
 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>
 123
 124
 125     </variablelist>
 126   </refsect1>
 127
 128   <refsect1>
 129     <title>
 130       DAEMON CONFIGURATION
 131     </title>
 132
 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>
 145
 146     <para>
 147       Many of these variables are also used by event scripts.
 148     </para>
 149
 150     <variablelist>
 151
 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>
 160
 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>
 170
 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>
 180
 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>
 190
 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>
 200
 201       <varlistentry>
 202         <term>CTDB_DEBUGLEVEL=<parameter>DEBUGLEVEL</parameter></term>
 203         <listitem>
 204           <para>
 205             Default is NOTICE (2).  Corresponds to <option>-d</option> or
 206             <option>--debug</option>.
 207           </para>
 208         </listitem>
 209       </varlistentry>
 210
 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>
 221
 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<optional>:<parameter>METHOD</parameter></optional></term>
 246               <listitem>
 247                 <para>
 248                   CTDB will log to syslog.  By default this will use
 249                   the syslog(3) API.
 250                 </para>
 251                 <para>
 252                   If METHOD is specified then it specifies an
 253                   extension that causes logging to be done in a
 254                   non-blocking fashion.  This can be useful under
 255                   heavy loads that might cause the syslog daemon to
 256                   dequeue messages too slowly, which would otherwise
 257                   cause CTDB to block when logging.  METHOD must be
 258                   one of:
 259                 </para>
 260                 <variablelist>
 261                   <varlistentry>
 262                     <term>nonblocking</term>
 263                     <listitem>
 264                       <para>
 265                         CTDB will log to syslog via
 266                         <filename>/dev/log</filename> in non-blocking
 267                         mode.
 268                       </para>
 269                     </listitem>
 270                   </varlistentry>
 271                   <varlistentry>
 272                     <term>udp</term>
 273                     <listitem>
 274                       <para>
 275                         CTDB will log to syslog via UDP to
 276                         localhost:514.  The syslog daemon must be
 277                         configured to listen on (at least)
 278                         localhost:514.  Most implementations will log
 279                         the messages against hostname "localhost" -
 280                         this is a limit of the implementation for
 281                         compatibility with more syslog daemon
 282                         implementations.
 283                       </para>
 284                     </listitem>
 285                   </varlistentry>
 286                   <varlistentry>
 287                     <term>udp-rfc5424</term>
 288                     <listitem>
 289                       <para>
 290                         As with "udp" but messages are sent in RFC5424
 291                         format.  This method will log the correct
 292                         hostname but is not as widely implemented in
 293                         syslog daemons.
 294                       </para>
 295                     </listitem>
 296                   </varlistentry>
 297                 </variablelist>
 298               </listitem>
 299             </varlistentry>
 300           </variablelist>
 301         </listitem>
 302       </varlistentry>
 303
 304       <varlistentry>
 305         <term>CTDB_LVS_PUBLIC_IP=<parameter>IPADDR</parameter></term>
 306         <listitem>
 307           <para>
 308             No default.  Corresponds to "<option>--lvs</option>
 309             <option>--single-public-ip IPADDR"</option>.
 310           </para>
 311         </listitem>
 312       </varlistentry>
 313
 314       <varlistentry>
 315         <term>CTDB_NODES=<parameter>FILENAME</parameter></term>
 316         <listitem>
 317           <para>
 318             Default is <varname>CTDB_BASE</varname>/nodes, so usually
 319             <filename>/etc/ctdb/nodes</filename>.  Corresponds to
 320             <option>--nlist</option>.
 321           </para>
 322         </listitem>
 323       </varlistentry>
 324
 325       <varlistentry>
 326         <term>CTDB_NOTIFY_SCRIPT=<parameter>FILENAME</parameter></term>
 327         <listitem>
 328           <para>
 329             No default, usually
 330             <filename>/etc/ctdb/notify.sh</filename>.  Corresponds to
 331             <option>--notification-script</option>.
 332           </para>
 333         </listitem>
 334       </varlistentry>
 335
 336       <varlistentry>
 337         <term>CTDB_MAX_PERSISTENT_CHECK_ERRORS=<parameter>NUM</parameter></term>
 338         <listitem>
 339           <para>
 340             Default 0.  Corresponds to
 341             <option>--max-persistent-check-errors</option>.
 342           </para>
 343         </listitem>
 344       </varlistentry>
 345
 346       <varlistentry>
 347         <term>CTDB_NODE_ADDRESS=<parameter>FILENAME</parameter></term>
 348         <listitem>
 349           <para>
 350             IPADDR is the private IP address that ctdbd will bind to.
 351             Corresponds to <option>--listen</option>.
 352           </para>
 353           <para>
 354             By default ctdbd will select the first address from the
 355             nodes list that in can bind to.  See also
 356             <citetitle>CTDB_NODES</citetitle>.
 357           </para>
 358           <para>
 359             This option is only required when automatic address
 360             detection can not be used.  This can be the case when
 361             running multiple ctdbd daemons/nodes on the same physical
 362             host (usually for testing), using InfiniBand for the
 363             private network or on Linux when sysctl
 364             net.ipv4.ip_nonlocal_bind=1.
 365           </para>
 366         </listitem>
 367       </varlistentry>
 368
 369       <varlistentry>
 370         <term>CTDB_PUBLIC_ADDRESSES=<parameter>FILENAME</parameter></term>
 371         <listitem>
 372           <para>
 373             No default, usually
 374             <filename>/etc/ctdb/public_addresses</filename>.
 375             Corresponds to <option>--public-addresses</option>.
 376           </para>
 377         </listitem>
 378       </varlistentry>
 379
 380       <varlistentry>
 381         <term>CTDB_PUBLIC_INTERFACE=<parameter>INTERFACE</parameter></term>
 382         <listitem>
 383           <para>
 384             No default.  Corresponds to
 385             <option>--public-interface</option>.
 386           </para>
 387         </listitem>
 388       </varlistentry>
 389
 390       <varlistentry>
 391         <term>CTDB_RECOVERY_LOCK=<parameter>FILENAME</parameter></term>
 392         <listitem>
 393           <para>
 394             Defaults to
 395             <filename>/some/place/on/shared/storage</filename>, which
 396             should be change to a useful value.  Corresponds to
 397             <option>--reclock</option>.
 398           </para>
 399           <para>
 400             For information about the recovery lock please see the
 401             <citetitle>RECOVERY LOCK</citetitle> section in
 402             <citerefentry><refentrytitle>ctdb</refentrytitle>
 403             <manvolnum>7</manvolnum></citerefentry>.
 404           </para>
 405         </listitem>
 406       </varlistentry>
 407
 408       <varlistentry>
 409         <term>CTDB_SCRIPT_LOG_LEVEL=<parameter>DEBUGLEVEL</parameter></term>
 410         <listitem>
 411           <para>
 412             Defaults to ERR (0).  Corresponds to
 413             <option>--script-log-level</option>.
 414           </para>
 415         </listitem>
 416       </varlistentry>
 417
 418       <varlistentry>
 419         <term>CTDB_SOCKET=<parameter>FILENAME</parameter></term>
 420         <listitem>
 421           <para>
 422             Defaults to <filename>/tmp/ctdb.socket</filename>.
 423             Corresponds to <option>--socket</option>.
 424           </para>
 425           <para>
 426             If you change this then you probably want to set this in
 427             root's enviroment (perhaps in a file in
 428             <filename>/etc/profile.d</filename>) so that you can use
 429             the <citerefentry><refentrytitle>ctdb</refentrytitle>
 430             <manvolnum>1</manvolnum></citerefentry> command in a
 431             straightforward manner.
 432           </para>
 433         </listitem>
 434       </varlistentry>
 435
 436       <varlistentry>
 437         <term>CTDB_START_AS_DISABLED=yes|no</term>
 438         <listitem>
 439           <para>
 440             Default is no.  Corresponds to
 441             <option>--start-as-disabled</option>.
 442           </para>
 443         </listitem>
 444       </varlistentry>
 445
 446       <varlistentry>
 447         <term>CTDB_START_AS_STOPPED=yes|no</term>
 448         <listitem>
 449           <para>
 450             Default is no.  Corresponds to
 451             <option>--start-as-stopped</option>.
 452           </para>
 453         </listitem>
 454       </varlistentry>
 455
 456       <varlistentry>
 457         <term>CTDB_TRANSPORT=tcp|infiniband</term>
 458         <listitem>
 459           <para>
 460             Defaults to tcp.  Corresponds to
 461             <option>--transport</option>.
 462           </para>
 463         </listitem>
 464       </varlistentry>
 465
 466     </variablelist>
 467
 468     <para>
 469       While the following variables do not translate into daemon
 470       options they are used by
 471       <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
 472       <manvolnum>1</manvolnum></citerefentry> when starting and
 473       stopping <citerefentry><refentrytitle>ctdbd</refentrytitle>
 474       <manvolnum>1</manvolnum></citerefentry>.
 475     </para>
 476
 477     <variablelist>
 478
 479       <varlistentry>
 480         <term>CTDB_SHUTDOWN_TIMEOUT=<parameter>NUM</parameter></term>
 481         <listitem>
 482           <para>
 483             NUM is the number of seconds to wait for
 484             <citerefentry><refentrytitle>ctdbd</refentrytitle>
 485             <manvolnum>1</manvolnum></citerefentry> to shut down
 486             gracefully before giving up and killing it.
 487           </para>
 488
 489           <para>
 490             Defaults is 30.
 491           </para>
 492         </listitem>
 493       </varlistentry>
 494
 495       <varlistentry>
 496         <term>CTDB_STARTUP_TIMEOUT=<parameter>NUM</parameter></term>
 497         <listitem>
 498           <para>
 499             NUM is the number of seconds to wait for
 500             <citerefentry><refentrytitle>ctdbd</refentrytitle>
 501             <manvolnum>1</manvolnum></citerefentry> complete early
 502             initialisation up to a point where it is unlikely to
 503             abort.  If <command>ctdbd</command> doesn't complete the
 504             "setup" event before this timeout then it is killed.
 505           </para>
 506
 507           <para>
 508             Defaults is 10.
 509           </para>
 510         </listitem>
 511       </varlistentry>
 512
 513     </variablelist>
 514   </refsect1>
 515
 516   <refsect1>
 517     <title>NETWORK CONFIGURATION</title>
 518
 519     <refsect2>
 520       <title>NAT GATEWAY</title>
 521
 522       <para>
 523         NAT gateway is used to configure fallback routing for nodes
 524         when they do not host any public IP addresses.  For example,
 525         it allows unhealthy nodes to reliably communicate with
 526         external infrastructure.  One node in a NAT gateway group will
 527         be designated as the NAT gateway master node and other (slave)
 528         nodes will be configured with fallback routes via the NAT
 529         gateway master node.  For more information, see the
 530         <citetitle>NAT GATEWAY</citetitle> section in
 531         <citerefentry><refentrytitle>ctdb</refentrytitle>
 532         <manvolnum>7</manvolnum></citerefentry>.
 533       </para>
 534
 535       <variablelist>
 536
 537         <varlistentry>
 538           <term>CTDB_NATGW_DEFAULT_GATEWAY=<parameter>IPADDR</parameter></term>
 539           <listitem>
 540             <para>
 541               IPADDR is an alternate network gateway to use on the NAT
 542               gateway master node.  If set, a fallback default route
 543               is added via this network gateway.
 544             </para>
 545             <para>
 546               No default.  Setting this variable is optional - if not
 547               set that no route is created on the NAT gateway master
 548               node.
 549             </para>
 550           </listitem>
 551         </varlistentry>
 552
 553         <varlistentry>
 554           <term>CTDB_NATGW_NODES=<parameter>FILENAME</parameter></term>
 555           <listitem>
 556             <para>
 557               FILENAME contains the list of nodes that belong to the
 558               same NAT gateway group.
 559             </para>
 560             <para>
 561               File format:
 562               <screen>
 563 <parameter>IPADDR</parameter>
 564               </screen>
 565             </para>
 566             <para>
 567               No default, usually
 568               <filename>/etc/ctdb/natgw_nodes</filename> when enabled.
 569             </para>
 570           </listitem>
 571         </varlistentry>
 572
 573         <varlistentry>
 574           <term>CTDB_NATGW_PRIVATE_NETWORK=<parameter>IPADDR/MASK</parameter></term>
 575           <listitem>
 576             <para>
 577               IPADDR/MASK is the private sub-network that is
 578               internally routed via the NAT gateway master node.  This
 579               is usually the private network that is used for node
 580               addresses.
 581             </para>
 582             <para>
 583               No default.
 584             </para>
 585           </listitem>
 586         </varlistentry>
 587
 588         <varlistentry>
 589           <term>CTDB_NATGW_PUBLIC_IFACE=<parameter>IFACE</parameter></term>
 590           <listitem>
 591             <para>
 592               IFACE is the network interface on which the
 593               CTDB_NATGW_PUBLIC_IP will be configured.
 594             </para>
 595             <para>
 596               No default.
 597             </para>
 598           </listitem>
 599         </varlistentry>
 600
 601         <varlistentry>
 602           <term>CTDB_NATGW_PUBLIC_IP=<parameter>IPADDR/MASK</parameter></term>
 603           <listitem>
 604             <para>
 605               IPADDR/MASK indicates the IP address that is used for
 606               outgoing traffic (originating from
 607               CTDB_NATGW_PRIVATE_NETWORK) on the NAT gateway master
 608               node.  This <emphasis>must not</emphasis> be a
 609               configured public IP address.
 610             </para>
 611             <para>
 612               No default.
 613             </para>
 614           </listitem>
 615         </varlistentry>
 616
 617         <varlistentry>
 618           <term>CTDB_NATGW_SLAVE_ONLY=yes|no</term>
 619           <listitem>
 620             <para>
 621               When set to "yes" a node can not be a NAT gateway master
 622               node.  In this case
 623               <varname>CTDB_NATGW_PUBLIC_IFACE</varname> and
 624               <varname>CTDB_NATGW_PUBLIC_IP</varname> are optional
 625               and unused.
 626             </para>
 627             <para>
 628               Default is no.
 629             </para>
 630           </listitem>
 631         </varlistentry>
 632
 633         <varlistentry>
 634           <term>CTDB_NATGW_STATIC_ROUTES=<parameter>IPADDR/MASK[@GATEWAY]</parameter> ...</term>
 635           <listitem>
 636             <para>
 637               Each IPADDR/MASK identifies a network or host to which
 638               NATGW should create a fallback route, instead of
 639               creating a single default route.  This can be used when
 640               there is already a default route, via an interface that
 641               can not reach required infrastructure, that overrides
 642               the NAT gateway default route.
 643             </para>
 644             <para>
 645               If GATEWAY is specified then the corresponding route on
 646               the NATGW master node will be via GATEWAY.  Such routes
 647               are created even if
 648               <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is not
 649               specified.  If GATEWAY is not specified for some
 650               networks then routes are only created on the NATGW
 651               master node for those networks if
 652               <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is
 653               specified.
 654             </para>
 655             <para>
 656               This should be used with care to avoid causing traffic
 657               to unnecessarily double-hop through the NAT gateway
 658               master, even when a node is hosting public IP addresses.
 659               Each specified network or host should probably have a
 660               corresponding automatically created link route or static
 661               route to avoid this.
 662             </para>
 663             <para>
 664               No default.
 665             </para>
 666           </listitem>
 667         </varlistentry>
 668
 669       </variablelist>
 670
 671       <refsect3>
 672         <title>Example</title>
 673         <screen>
 674 CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
 675 CTDB_NATGW_PRIVATE_NETWORK=192.168.1.0/24
 676 CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
 677 CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
 678 CTDB_NATGW_PUBLIC_IFACE=eth0
 679         </screen>
 680
 681         <para>
 682           A variation that ensures that infrastructure (ADS, DNS, ...)
 683           directly attached to the public network (10.0.0.0/24) is
 684           always reachable would look like this:
 685         </para>
 686         <screen>
 687 CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
 688 CTDB_NATGW_PRIVATE_NETWORK=192.168.1.0/24
 689 CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
 690 CTDB_NATGW_PUBLIC_IFACE=eth0
 691 CTDB_NATGW_STATIC_ROUTES=10.0.0.0/24
 692         </screen>
 693         <para>
 694           Note that <varname>CTDB_NATGW_DEFAULT_GATEWAY</varname> is
 695           not specified.
 696         </para>
 697       </refsect3>
 698
 699     </refsect2>
 700
 701     <refsect2>
 702       <title>POLICY ROUTING</title>
 703
 704       <para>
 705         A node running CTDB may be a component of a complex network
 706         topology.  In particular, public addresses may be spread
 707         across several different networks (or VLANs) and it may not be
 708         possible to route packets from these public addresses via the
 709         system's default route.  Therefore, CTDB has support for
 710         policy routing via the <filename>13.per_ip_routing</filename>
 711         eventscript.  This allows routing to be specified for packets
 712         sourced from each public address.  The routes are added and
 713         removed as CTDB moves public addresses between nodes.
 714       </para>
 715
 716       <para>
 717         For more information, see the <citetitle>POLICY
 718         ROUTING</citetitle> section in
 719         <citerefentry><refentrytitle>ctdb</refentrytitle>
 720         <manvolnum>7</manvolnum></citerefentry>.
 721       </para>
 722
 723       <variablelist>
 724         <varlistentry>
 725           <term>CTDB_PER_IP_ROUTING_CONF=<parameter>FILENAME</parameter></term>
 726           <listitem>
 727             <para>
 728               FILENAME contains elements for constructing the desired
 729               routes for each source address.
 730             </para>
 731
 732             <para>
 733               The special FILENAME value
 734               <constant>__auto_link_local__</constant> indicates that no
 735               configuration file is provided and that CTDB should
 736               generate reasonable link-local routes for each public IP
 737               address.
 738             </para>
 739
 740             <para>
 741               File format:
 742               <screen>
 743 <parameter>IPADDR</parameter> <parameter>DEST-IPADDR/MASK</parameter> <optional><parameter>GATEWAY-IPADDR</parameter></optional>
 744               </screen>
 745             </para>
 746
 747             <para>
 748               No default, usually
 749               <filename>/etc/ctdb/policy_routing</filename> when enabled.
 750             </para>
 751           </listitem>
 752         </varlistentry>
 753
 754         <varlistentry>
 755           <term>CTDB_PER_IP_ROUTING_RULE_PREF=<parameter>NUM</parameter></term>
 756         <listitem>
 757           <para>
 758             NUM sets the priority (or preference) for the routing
 759             rules that are added by CTDB.
 760           </para>
 761
 762           <para>
 763             This should be (strictly) greater than 0 and (strictly)
 764             less than 32766.  A priority of 100 is recommended, unless
 765             this conflicts with a priority already in use on the
 766             system.  See
 767             <citerefentry><refentrytitle>ip</refentrytitle>
 768             <manvolnum>8</manvolnum></citerefentry>, for more details.
 769           </para>
 770         </listitem>
 771         </varlistentry>
 772
 773         <varlistentry>
 774           <term>
 775             CTDB_PER_IP_ROUTING_TABLE_ID_LOW=<parameter>LOW-NUM</parameter>,
 776             CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=<parameter>HIGH-NUM</parameter>
 777           </term>
 778           <listitem>
 779             <para>
 780               CTDB determines a unique routing table number to use for
 781               the routing related to each public address.  LOW-NUM and
 782               HIGH-NUM indicate the minimum and maximum routing table
 783               numbers that are used.
 784             </para>
 785
 786             <para>
 787               <citerefentry><refentrytitle>ip</refentrytitle>
 788               <manvolnum>8</manvolnum></citerefentry> uses some
 789               reserved routing table numbers below 255.  Therefore,
 790               CTDB_PER_IP_ROUTING_TABLE_ID_LOW should be (strictly)
 791               greater than 255.
 792             </para>
 793
 794             <para>
 795               CTDB uses the standard file
 796               <filename>/etc/iproute2/rt_tables</filename> to maintain
 797               a mapping between the routing table numbers and labels.
 798               The label for a public address
 799               <replaceable>ADDR</replaceable> will look like
 800               ctdb.<replaceable>addr</replaceable>.  This means that
 801               the associated rules and routes are easy to read (and
 802               manipulate).
 803             </para>
 804
 805             <para>
 806               No default, usually 1000 and 9000.
 807             </para>
 808           </listitem>
 809         </varlistentry>
 810       </variablelist>
 811
 812       <refsect3>
 813         <title>Example</title>
 814         <screen>
 815 CTDB_PER_IP_ROUTING_CONF=/etc/ctdb/policy_routing
 816 CTDB_PER_IP_ROUTING_RULE_PREF=100
 817 CTDB_PER_IP_ROUTING_TABLE_ID_LOW=1000
 818 CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=9000
 819         </screen>
 820       </refsect3>
 821
 822     </refsect2>
 823
 824     <refsect2>
 825       <title>MISCELLANEOUS NETWORK CONFIGURATION</title>
 826
 827       <variablelist>
 828
 829         <varlistentry>
 830           <term>CTDB_PARTIALLY_ONLINE_INTERFACES=yes|no</term>
 831           <listitem>
 832             <para>
 833               Whether one or more offline interfaces should cause a
 834               monitor event to fail if there are other interfaces that
 835               are up.  If this is "yes" and a node has some interfaces
 836               that are down then <command>ctdb status</command> will
 837               display the node as "PARTIALLYONLINE".
 838             </para>
 839
 840             <para>
 841               Default is "no".
 842             </para>
 843           </listitem>
 844         </varlistentry>
 845
 846       </variablelist>
 847     </refsect2>
 848
 849   </refsect1>
 850
 851   <refsect1>
 852     <title>SERVICE CONFIGURATION</title>
 853
 854     <para>
 855       CTDB can be configured to manage and/or monitor various NAS (and
 856       other) services via its eventscripts.
 857     </para>
 858
 859     <para>
 860       In the simplest case CTDB will manage a service.  This means the
 861       service will be started and stopped along with CTDB, CTDB will
 862       monitor the service and CTDB will do any required
 863       reconfiguration of the service when public IP addresses are
 864       failed over.
 865     </para>
 866
 867     <refsect2>
 868       <title>SAMBA</title>
 869
 870       <refsect3>
 871         <title>Eventscripts</title>
 872
 873         <simplelist>
 874           <member><filename>49.winbind</filename></member>
 875           <member><filename>50.samba</filename></member>
 876         </simplelist>
 877       </refsect3>
 878
 879       <variablelist>
 880
 881         <varlistentry>
 882           <term>CTDB_MANAGES_SAMBA=yes|no</term>
 883           <listitem>
 884             <para>
 885               Should CTDB manage Samba?
 886             </para>
 887             <para>
 888               Default is no.
 889             </para>
 890           </listitem>
 891         </varlistentry>
 892
 893         <varlistentry>
 894           <term>CTDB_MANAGES_WINBIND=yes|no</term>
 895           <listitem>
 896             <para>
 897               Should CTDB manage Winbind?
 898             </para>
 899             <para>
 900               Default is no.
 901             </para>
 902           </listitem>
 903         </varlistentry>
 904
 905         <varlistentry>
 906           <term>CTDB_SAMBA_CHECK_PORTS=<parameter>PORT-LIST</parameter></term>
 907           <listitem>
 908             <para>
 909               When monitoring Samba, check TCP ports in
 910               space-separated PORT-LIST.
 911             </para>
 912             <para>
 913               Default is to monitor ports that Samba is configured to listen on.
 914             </para>
 915           </listitem>
 916         </varlistentry>
 917
 918         <varlistentry>
 919           <term>CTDB_SAMBA_SKIP_SHARE_CHECK=yes|no</term>
 920           <listitem>
 921             <para>
 922               As part of monitoring, should CTDB skip the check for
 923               the existence of each directory configured as share in
 924               Samba.  This may be desirable if there is a large number
 925               of shares.
 926             </para>
 927             <para>
 928               Default is no.
 929             </para>
 930           </listitem>
 931         </varlistentry>
 932
 933         <varlistentry>
 934           <term>CTDB_SERVICE_NMB=<parameter>SERVICE</parameter></term>
 935           <listitem>
 936             <para>
 937               Distribution specific SERVICE for managing nmbd.
 938             </para>
 939             <para>
 940               Default is distribution-dependant.
 941             </para>
 942           </listitem>
 943         </varlistentry>
 944         <varlistentry>
 945           <term>CTDB_SERVICE_SMB=<parameter>SERVICE</parameter></term>
 946           <listitem>
 947             <para>
 948               Distribution specific SERVICE for managing smbd.
 949             </para>
 950             <para>
 951               Default is distribution-dependant.
 952             </para>
 953           </listitem>
 954         </varlistentry>
 955
 956         <varlistentry>
 957           <term>CTDB_SERVICE_WINBIND=<parameter>SERVICE</parameter></term>
 958           <listitem>
 959             <para>
 960               Distribution specific SERVICE for managing winbindd.
 961             </para>
 962             <para>
 963               Default is "winbind".
 964             </para>
 965           </listitem>
 966         </varlistentry>
 967
 968       </variablelist>
 969
 970     </refsect2>
 971
 972     <refsect2>
 973       <title>NFS</title>
 974
 975       <para>
 976         This includes parameters for the kernel NFS server.
 977         Alternative NFS subsystems (such as <ulink
 978         url="https://github.com/nfs-ganesha/nfs-ganesha/wiki">NFS-Ganesha</ulink>)
 979         can be integrated using <varname>CTDB_NFS_CALLOUT</varname>.
 980       </para>
 981
 982       <refsect3>
 983         <title>Eventscript</title>
 984
 985         <simplelist>
 986           <member><filename>60.nfs</filename></member>
 987         </simplelist>
 988       </refsect3>
 989
 990       <variablelist>
 991
 992         <varlistentry>
 993           <term>CTDB_CLUSTER_FILESYSTEM_TYPE=gpfs</term>
 994           <listitem>
 995             <para>
 996               The type of cluster filesystem to use with NFS-ganesha.
 997               Currently only "gpfs" is supported.
 998             </para>
 999             <para>
1000               Default is "gpfs".
1001             </para>
1002           </listitem>
1003         </varlistentry>
1004
1005         <varlistentry>
1006           <term>CTDB_MANAGES_NFS=yes|no</term>
1007           <listitem>
1008             <para>
1009               Should CTDB manage NFS?
1010             </para>
1011             <para>
1012               Default is no.
1013             </para>
1014           </listitem>
1015         </varlistentry>
1016
1017         <varlistentry>
1018           <term>CTDB_NFS_CALLOUT=<parameter>COMMAND</parameter></term>
1019           <listitem>
1020             <para>
1021               COMMAND specifies the path to a callout to handle
1022               interactions with the configured NFS system, including
1023               startup, shutdown, monitoring.
1024             </para>
1025             <para>
1026               Default is the included
1027               <command>nfs-linux-kernel-callout</command>.
1028             </para>
1029           </listitem>
1030         </varlistentry>
1031
1032         <varlistentry>
1033           <term>CTDB_NFS_SKIP_SHARE_CHECK=yes|no</term>
1034           <listitem>
1035             <para>
1036               As part of monitoring, should CTDB skip the check for
1037               the existence of each directory exported via NFS.  This
1038               may be desirable if there is a large number of exports.
1039             </para>
1040             <para>
1041               Default is no.
1042             </para>
1043           </listitem>
1044         </varlistentry>
1045
1046         <varlistentry>
1047           <term>CTDB_RPCINFO_LOCALHOST=<parameter>IPADDR</parameter>|<parameter>HOSTNAME</parameter></term>
1048           <listitem>
1049             <para>
1050               IPADDR or HOSTNAME indicates the address that
1051               <command>rpcinfo</command> should connect to when doing
1052               <command>rpcinfo</command> check on IPv4 RPC service during
1053               monitoring.  Optimally this would be "localhost".
1054               However, this can add some performance overheads.
1055             </para>
1056             <para>
1057               Default is "127.0.0.1".
1058             </para>
1059           </listitem>
1060         </varlistentry>
1061
1062         <varlistentry>
1063           <term>CTDB_RPCINFO_LOCALHOST6=<parameter>IPADDR</parameter>|<parameter>HOSTNAME</parameter></term>
1064           <listitem>
1065             <para>
1066               IPADDR or HOSTNAME indicates the address that
1067               <command>rpcinfo</command> should connect to when doing
1068               <command>rpcinfo</command> check on IPv6 RPC service
1069               during monitoring.  Optimally this would be "localhost6"
1070               (or similar).  However, this can add some performance
1071               overheads.
1072             </para>
1073             <para>
1074               Default is "::1".
1075             </para>
1076           </listitem>
1077         </varlistentry>
1078
1079       </variablelist>
1080
1081     </refsect2>
1082
1083     <refsect2>
1084       <title>APACHE HTTPD</title>
1085
1086       <para>
1087         CTDB can manage the Apache web server.
1088       </para>
1089
1090       <refsect3>
1091         <title>Eventscript</title>
1092
1093         <simplelist>
1094           <member><filename>41.httpd</filename></member>
1095         </simplelist>
1096       </refsect3>
1097
1098       <variablelist>
1099         <varlistentry>
1100           <term>CTDB_MANAGES_HTTPD=yes|no</term>
1101           <listitem>
1102             <para>
1103               Should CTDB manage the Apache web server?
1104             </para>
1105             <para>
1106               Default is no.
1107             </para>
1108           </listitem>
1109         </varlistentry>
1110       </variablelist>
1111     </refsect2>
1112
1113     <refsect2>
1114       <title>CLAMAV</title>
1115
1116       <para>
1117         CTDB has support to manage the popular anti-virus daemon
1118         ClamAV.
1119       </para>
1120
1121       <refsect3>
1122         <title>Eventscript</title>
1123
1124         <simplelist>
1125           <member><filename>31.clamd</filename></member>
1126         </simplelist>
1127
1128         <para>
1129           This eventscript is not enabled by default.  Use
1130           <command>ctdb enablescript</command> to enable it.
1131         </para>
1132
1133       </refsect3>
1134
1135       <variablelist>
1136
1137         <varlistentry>
1138           <term>CTDB_MANAGES_CLAMD=yes|no</term>
1139           <listitem>
1140             <para>
1141               Should CTDB manage ClamAV?
1142             </para>
1143             <para>
1144               Default is no.
1145             </para>
1146           </listitem>
1147         </varlistentry>
1148
1149         <varlistentry>
1150           <term>CTDB_CLAMD_SOCKET=<parameter>FILENAME</parameter></term>
1151           <listitem>
1152             <para>
1153               FILENAME is the socket to monitor ClamAV.
1154             </para>
1155             <para>
1156               No default.
1157             </para>
1158           </listitem>
1159         </varlistentry>
1160
1161       </variablelist>
1162
1163     </refsect2>
1164
1165     <refsect2>
1166       <title>ISCSI</title>
1167
1168       <para>
1169         CTDB has support for managing the Linux iSCSI tgtd service.
1170       </para>
1171
1172       <refsect3>
1173         <title>Eventscript</title>
1174
1175         <simplelist>
1176           <member><filename>70.iscsi</filename></member>
1177         </simplelist>
1178       </refsect3>
1179
1180       <variablelist>
1181
1182         <varlistentry>
1183           <term>CTDB_MANAGES_ISCSI=yes|no</term>
1184           <listitem>
1185             <para>
1186               Should CTDB manage iSCSI tgtd?
1187             </para>
1188             <para>
1189               Default is no.
1190             </para>
1191           </listitem>
1192         </varlistentry>
1193
1194         <varlistentry>
1195           <term>CTDB_START_ISCSI_SCRIPTS=<parameter>DIRECTORY</parameter></term>
1196           <listitem>
1197             <para>
1198               DIRECTORY on shared storage containing scripts to start
1199               tgtd for each public IP address.
1200             </para>
1201             <para>
1202               No default.
1203             </para>
1204           </listitem>
1205         </varlistentry>
1206       </variablelist>
1207     </refsect2>
1208
1209     <refsect2>
1210       <title>MULTIPATHD</title>
1211
1212       <para>
1213         CTDB can monitor multipath devices to ensure that active paths
1214         are available.
1215       </para>
1216
1217       <refsect3>
1218         <title>Eventscript</title>
1219
1220         <simplelist>
1221           <member><filename>20.multipathd</filename></member>
1222         </simplelist>
1223
1224         <para>
1225           This eventscript is not enabled by default.  Use
1226           <command>ctdb enablescript</command> to enable it.
1227         </para>
1228       </refsect3>
1229
1230       <variablelist>
1231         <varlistentry>
1232           <term>CTDB_MONITOR_MPDEVICES=<parameter>MP-DEVICE-LIST</parameter></term>
1233           <listitem>
1234             <para>
1235               MP-DEVICE-LIST is a list of multipath devices for CTDB to monitor?
1236             </para>
1237             <para>
1238               No default.
1239             </para>
1240           </listitem>
1241         </varlistentry>
1242       </variablelist>
1243     </refsect2>
1244
1245     <refsect2>
1246       <title>VSFTPD</title>
1247
1248       <para>
1249         CTDB can manage the vsftpd FTP server.
1250       </para>
1251
1252       <refsect3>
1253         <title>Eventscript</title>
1254
1255         <simplelist>
1256           <member><filename>40.vsftpd</filename></member>
1257         </simplelist>
1258       </refsect3>
1259
1260       <variablelist>
1261         <varlistentry>
1262           <term>CTDB_MANAGES_VSFTPD=yes|no</term>
1263           <listitem>
1264             <para>
1265               Should CTDB manage the vsftpd FTP server?
1266             </para>
1267             <para>
1268               Default is no.
1269             </para>
1270           </listitem>
1271         </varlistentry>
1272       </variablelist>
1273     </refsect2>
1274
1275     <refsect2>
1276       <title>
1277         SYSTEM RESOURCE MONITORING CONFIGURATION
1278       </title>
1279
1280       <para>
1281         CTDB can experience seemingly random (performance and other)
1282         issues if system resources become too constrained.  Options in
1283         this section can be enabled to allow certain system resources to
1284         be checked.
1285       </para>
1286
1287       <refsect3>
1288         <title>Eventscripts</title>
1289
1290         <simplelist>
1291           <member><filename>05.system</filename></member>
1292         </simplelist>
1293
1294         <para>
1295           Filesystem and memory usage monitoring is in
1296           <filename>05.system</filename>.  This eventscript is not
1297           enabled by default.  Use <command>ctdb
1298           enablescript</command> to enable it.
1299         </para>
1300       </refsect3>
1301
1302       <variablelist>
1303
1304         <varlistentry>
1305           <term>CTDB_MONITOR_FILESYSTEM_USAGE=<parameter>FS-LIMIT-LIST</parameter></term>
1306           <listitem>
1307             <para>
1308               FS-LIMIT-LIST is a space-separated list of
1309               <parameter>FILESYSTEM</parameter>:<parameter>WARN_LIMIT</parameter><optional>:<parameter>UNHEALTHY_LIMIT</parameter></optional>
1310               triples indicating that warnings should be logged if the
1311               space used on FILESYSTEM reaches WARN_LIMIT%.  If usage
1312               reaches UNHEALTHY_LIMIT then the node should be flagged
1313               unhealthy.  Either WARN_LIMIT or UNHEALTHY_LIMIT may be
1314               left blank, meaning that check will be omitted.
1315             </para>
1316
1317             <para>
1318               No default.
1319             </para>
1320           </listitem>
1321         </varlistentry>
1322
1323         <varlistentry>
1324           <term>CTDB_MONITOR_MEMORY_USAGE=<parameter>MEM-LIMITS</parameter></term>
1325           <listitem>
1326             <para>
1327               MEM-LIMITS takes the form
1328               <parameter>WARN_LIMIT</parameter><optional>:<parameter>UNHEALTHY_LIMIT</parameter></optional>
1329               indicating that warnings should be logged if memory
1330               usage reaches WARN_LIMIT%.  If usage reaches
1331               UNHEALTHY_LIMIT then the node should be flagged
1332               unhealthy.  Either WARN_LIMIT or UNHEALTHY_LIMIT may be
1333               left blank, meaning that check will be omitted.
1334             </para>
1335             <para>
1336               No default.
1337             </para>
1338           </listitem>
1339         </varlistentry>
1340
1341         <varlistentry>
1342           <term>CTDB_MONITOR_SWAP_USAGE=<parameter>SWAP-LIMITS</parameter></term>
1343           <listitem>
1344             <para>
1345               SWAP-LIMITS takes the form
1346               <parameter>WARN_LIMIT</parameter><optional>:<parameter>UNHEALTHY_LIMIT</parameter></optional>
1347                indicating that warnings should be logged if
1348               swap usage reaches WARN_LIMIT%.  If usage reaches
1349               UNHEALTHY_LIMIT then the node should be flagged
1350               unhealthy.  Either WARN_LIMIT or UNHEALTHY_LIMIT may be
1351               left blank, meaning that check will be omitted.
1352             </para>
1353             <para>
1354               No default.
1355             </para>
1356           </listitem>
1357         </varlistentry>
1358
1359       </variablelist>
1360     </refsect2>
1361
1362     <refsect2>
1363       <title>MISCELLANEOUS SERVICE-RELATED CONFIGURATION</title>
1364
1365       <variablelist>
1366
1367         <varlistentry>
1368           <term>CTDB_MANAGED_SERVICES=<parameter>SERVICE-LIST</parameter></term>
1369           <listitem>
1370             <para>
1371               SERVICE-LIST is a space-separated list of SERVICEs that
1372               CTDB should manage.  This can be used as an alternative
1373               to the
1374               <varname>CTDB_MANAGES_<replaceable>SERVICE</replaceable></varname>
1375               variables.
1376             </para>
1377             <para>
1378               No default.
1379             </para>
1380           </listitem>
1381         </varlistentry>
1382
1383         <varlistentry>
1384           <term>CTDB_SERVICE_AUTOSTARTSTOP=yes|no</term>
1385           <listitem>
1386             <para>
1387               When CTDB should start and stop services if they become
1388               managed or unmanaged.
1389             </para>
1390             <para>
1391               Default is no.
1392             </para>
1393           </listitem>
1394         </varlistentry>
1395
1396       </variablelist>
1397
1398     </refsect2>
1399
1400   </refsect1>
1401
1402   <refsect1>
1403     <title>
1404       TUNABLES CONFIGURATION
1405     </title>
1406
1407     <para>
1408       CTDB tunables (see
1409       <citerefentry><refentrytitle>ctdbd-tunables</refentrytitle>
1410       <manvolnum>7</manvolnum></citerefentry>) can be set from the
1411       configuration file.  They are set as follows:
1412
1413       <literallayout>
1414 CTDB_SET_<replaceable>TUNABLE</replaceable>=<replaceable>VALUE</replaceable>
1415       </literallayout>
1416     </para>
1417
1418     <para>
1419       For example:
1420
1421       <screen format="linespecific">
1422 CTDB_SET_MonitorInterval=20
1423       </screen>
1424     </para>
1425   </refsect1>
1426
1427   <refsect1>
1428     <title>
1429       DEBUG AND TEST
1430     </title>
1431
1432     <para>
1433       Variable in this section are for debugging and testing CTDB.
1434       They should not generally be needed.
1435     </para>
1436
1437     <variablelist>
1438
1439       <varlistentry>
1440         <term>CTDB_DEBUG_HUNG_SCRIPT=<parameter>FILENAME</parameter></term>
1441         <listitem>
1442           <para>
1443             FILENAME is a script to run to log debug information when
1444             an event script times out.
1445           </para>
1446           <para>
1447             Default is <filename><varname>CTDB_BASE</varname>/debug-hung-script.sh</filename>.
1448           </para>
1449         </listitem>
1450       </varlistentry>
1451
1452       <varlistentry>
1453         <term>CTDB_DEBUG_HUNG_SCRIPT_LOGFILE=<parameter>FILENAME</parameter></term>
1454         <listitem>
1455           <para>
1456             FILENAME specifies where log messages should go when
1457             debugging hung eventscripts.  This is a testing option.
1458             See also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
1459           </para>
1460           <para>
1461             No default.  Messages go to stdout/stderr and are logged
1462             to the same place as other CTDB log messages.
1463           </para>
1464         </listitem>
1465       </varlistentry>
1466
1467       <varlistentry>
1468         <term>CTDB_DEBUG_HUNG_SCRIPT_STACKPAT=<parameter>REGEXP</parameter></term>
1469         <listitem>
1470           <para>
1471             REGEXP specifies interesting processes for which stack
1472             traces should be logged when debugging hung eventscripts
1473             and those processes are matched in pstree output.  REGEXP
1474             is an extended regexp so choices are separated by pipes
1475             ('|').  However, REGEXP should not contain parentheses.
1476             See also <citetitle>CTDB_DEBUG_HUNG_SCRIPT</citetitle>.
1477           </para>
1478           <para>
1479             Default is "exportfs|rpcinfo".
1480           </para>
1481         </listitem>
1482       </varlistentry>
1483
1484       <varlistentry>
1485         <term>CTDB_DEBUG_LOCKS=<parameter>FILENAME</parameter></term>
1486         <listitem>
1487           <para>
1488             FILENAME is a script to run to log debug information when
1489             an CTDB fails to freeze databases during recovery.
1490           </para>
1491           <para>
1492             No default, usually
1493             <filename><varname>CTDB_BASE</varname>/debug_locks.sh</filename>.
1494           </para>
1495         </listitem>
1496       </varlistentry>
1497
1498       <varlistentry>
1499         <term>CTDB_ETCDIR=<parameter>DIRECTORY</parameter></term>
1500         <listitem>
1501           <para>
1502             DIRECTORY containing system configuration files.  This is
1503             used to provide alternate configuration when testing and
1504             should not need to be changed from the default.
1505           </para>
1506           <para>
1507             Default is <filename>/etc</filename>.
1508           </para>
1509         </listitem>
1510       </varlistentry>
1511
1512       <varlistentry>
1513         <term>CTDB_INIT_STYLE=debian|redhat|suse</term>
1514         <listitem>
1515           <para>
1516             This is the init style used by the Linux distribution (or
1517             other operating system) being used.  This is usually
1518             determined dynamically by checking the system.  This
1519             variable is used by the initscript to determine which init
1520             system primitives to use.  It is also used by some
1521             eventscripts to choose the name of initscripts for certain
1522             services, since these can vary between distributions.
1523           </para>
1524           <para>
1525             No fixed default.
1526           </para>
1527           <para>
1528             If this option needs to be changed from the calculated
1529             default for the initscript to function properly, then it
1530             must be set in the distribution-specific initscript
1531             configuration, such as
1532             <filename>/etc/sysconfig/ctdb</filename>
1533           </para>
1534         </listitem>
1535       </varlistentry>
1536
1537       <varlistentry>
1538         <term>CTDB_MAX_CORRUPT_DB_BACKUPS=<parameter>NUM</parameter></term>
1539         <listitem>
1540           <para>
1541             NUM is the maximum number of volatile TDB database backups
1542             to be kept (for each database) when a corrupt database is
1543             found during startup.  Volatile TDBs are zeroed during
1544             startup so backups are needed to debug any corruption that
1545             occurs before a restart.
1546           </para>
1547           <para>
1548             Default is 10.
1549           </para>
1550         </listitem>
1551       </varlistentry>
1552
1553       <varlistentry>
1554         <term>CTDB_MAX_OPEN_FILES=<parameter>NUM</parameter></term>
1555         <listitem>
1556           <para>
1557             NUM is the maximum number of open files.
1558           </para>
1559           <para>
1560             There is no default.
1561           </para>
1562         </listitem>
1563       </varlistentry>
1564
1565       <varlistentry>
1566         <term>CTDB_RC_LOCAL=<parameter>FILENAME</parameter></term>
1567         <listitem>
1568           <para>
1569             FILENAME is a script fragment to be sourced by the
1570             <filename>functions</filename> that is sourced by scripts.
1571             On example use would be to override function definitions
1572             in unit tests.  As a sanity check, this file must be
1573             executable for it to be used.
1574           </para>
1575           <para>
1576             No default.
1577           </para>
1578         </listitem>
1579       </varlistentry>
1580
1581       <varlistentry>
1582         <term>CTDB_RUN_TIMEOUT_MONITOR=yes|no</term>
1583         <listitem>
1584           <para>
1585             Whether CTDB should simulate timing out monitor events.
1586             This uses the <filename>99.timeout</filename> eventscript.
1587           </para>
1588           <para>
1589             Default is no.
1590           </para>
1591         </listitem>
1592       </varlistentry>
1593
1594       <varlistentry>
1595         <term>CTDB_SCRIPT_DEBUGLEVEL=<parameter>NUM</parameter></term>
1596         <listitem>
1597           <para>
1598             NUM is the level debugging messages printed by CTDB
1599             scripts.  Setting this to a higher number (e.g. 4) will
1600             cause some scripts to log more messages.
1601           </para>
1602           <para>
1603             Default is 2.
1604           </para>
1605         </listitem>
1606       </varlistentry>
1607
1608       <varlistentry>
1609         <term>CTDB_SUPPRESS_COREFILE=yes|no</term>
1610         <listitem>
1611           <para>
1612             Whether CTDB core files should be suppressed.
1613           </para>
1614           <para>
1615             Default is no.
1616           </para>
1617         </listitem>
1618       </varlistentry>
1619
1620       <varlistentry>
1621         <term>CTDB_VALGRIND=yes|no|<parameter>COMMAND</parameter></term>
1622         <listitem>
1623           <para>
1624             If "yes", this causes
1625             <citerefentry><refentrytitle>ctdbd</refentrytitle>
1626             <manvolnum>1</manvolnum></citerefentry> to be run under
1627             <citerefentry><refentrytitle>valgrind</refentrytitle>
1628             <manvolnum>1</manvolnum></citerefentry> with logs going to
1629             <filename>/var/log/ctdb_valgrind</filename>.  If neither
1630             "yes" nor "no" then the value is assumed to be a COMMAND
1631             (e.g. a <command>valgrind</command> variation, a
1632             <citerefentry><refentrytitle>gdb</refentrytitle>
1633             <manvolnum>1</manvolnum></citerefentry> command) that is
1634             used in place of the default <command>valgrind</command>
1635             command.  In either case, the <option>--valgrind</option>
1636             option is passed to <command>ctdbd</command>.
1637           </para>
1638           <para>
1639             Default is no.
1640           </para>
1641         </listitem>
1642       </varlistentry>
1643
1644     </variablelist>
1645
1646   </refsect1>
1647
1648
1649   <refsect1>
1650     <title>FILES</title>
1651
1652     <simplelist>
1653       <member><filename>/etc/ctdb/ctdbd.conf</filename></member>
1654       <member><filename>/etc/sysconfig/ctdb</filename></member>
1655       <member><filename>/etc/default/ctdb</filename></member>
1656       <member><filename>/etc/ctdb/sysconfig/ctdb</filename></member>
1657     </simplelist>
1658   </refsect1>
1659
1660   <refsect1>
1661     <title>SEE ALSO</title>
1662     <para>
1663       <citerefentry><refentrytitle>ctdbd</refentrytitle>
1664       <manvolnum>1</manvolnum></citerefentry>,
1665
1666       <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
1667       <manvolnum>1</manvolnum></citerefentry>,
1668
1669       <citerefentry><refentrytitle>onnode</refentrytitle>
1670       <manvolnum>1</manvolnum></citerefentry>,
1671
1672       <citerefentry><refentrytitle>ctdb</refentrytitle>
1673       <manvolnum>7</manvolnum></citerefentry>,
1674
1675       <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
1676       <manvolnum>7</manvolnum></citerefentry>,
1677
1678       <ulink url="http://ctdb.samba.org/"/>
1679     </para>
1680   </refsect1>
1681
1682   <refentryinfo>
1683     <author>
1684       <contrib>
1685         This documentation was written by
1686         Amitay Isaacs,
1687         Martin Schwenke
1688       </contrib>
1689     </author>
1690
1691     <copyright>
1692       <year>2007</year>
1693       <holder>Andrew Tridgell</holder>
1694       <holder>Ronnie Sahlberg</holder>
1695     </copyright>
1696     <legalnotice>
1697       <para>
1698         This program is free software; you can redistribute it and/or
1699         modify it under the terms of the GNU General Public License as
1700         published by the Free Software Foundation; either version 3 of
1701         the License, or (at your option) any later version.
1702       </para>
1703       <para>
1704         This program is distributed in the hope that it will be
1705         useful, but WITHOUT ANY WARRANTY; without even the implied
1706         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
1707         PURPOSE.  See the GNU General Public License for more details.
1708       </para>
1709       <para>
1710         You should have received a copy of the GNU General Public
1711         License along with this program; if not, see
1712         <ulink url="http://www.gnu.org/licenses"/>.
1713       </para>
1714     </legalnotice>
1715   </refentryinfo>
1716
1717 </refentry>