ctdb/doc/ctdbd.1.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.1">
   7
   8   <refmeta>
   9     <refentrytitle>ctdbd</refentrytitle>
  10     <manvolnum>1</manvolnum>
  11     <refmiscinfo class="source">ctdb</refmiscinfo>
  12     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
  13   </refmeta>
  14
  15   <refnamediv>
  16     <refname>ctdbd</refname>
  17     <refpurpose>The CTDB cluster daemon</refpurpose>
  18   </refnamediv>
  19
  20   <refsynopsisdiv>
  21     <cmdsynopsis>
  22       <command>ctdbd</command>
  23       <arg rep="repeat"><replaceable>OPTION</replaceable></arg>
  24     </cmdsynopsis>
  25   </refsynopsisdiv>
  26
  27   <refsect1>
  28     <title>DESCRIPTION</title>
  29     <para>
  30       ctdbd is the main CTDB daemon.
  31     </para>
  32
  33     <para>
  34       Note that ctdbd is not usually invoked directly.  It is invoked
  35       via <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
  36       <manvolnum>1</manvolnum></citerefentry> or via the initscript.
  37     </para>
  38
  39     <para>
  40       See <citerefentry><refentrytitle>ctdb</refentrytitle>
  41       <manvolnum>7</manvolnum></citerefentry> for an overview of CTDB.
  42     </para>
  43   </refsect1>
  44
  45   <refsect1>
  46     <title>GENERAL OPTIONS</title>
  47
  48     <variablelist>
  49       <varlistentry>
  50         <term>-d, --debug=<parameter>DEBUGLEVEL</parameter></term>
  51         <listitem>
  52           <para>
  53             This option sets the debug level to DEBUGLEVEL, which
  54             controls what will be written by the logging
  55             subsystem.  The default is 2.
  56           </para>
  57           <para>
  58             See the <citetitle>DEBUG LEVELS</citetitle> section in
  59             <citerefentry><refentrytitle>ctdb</refentrytitle>
  60             <manvolnum>7</manvolnum></citerefentry> for more
  61             information.
  62           </para>
  63         </listitem>
  64       </varlistentry>
  65
  66       <varlistentry>
  67         <term>--dbdir=<parameter>DIRECTORY</parameter></term>
  68         <listitem>
  69           <para>
  70             DIRECTORY on local storage where ctdbd keeps a local copy of
  71             TDB databases.  This directory is local for each node and
  72             should not be stored on the shared cluster filesystem.
  73           </para>
  74           <para>
  75             Defaults to <filename>/usr/local/var/lib/ctdb</filename>.
  76           </para>
  77         </listitem>
  78       </varlistentry>
  79
  80       <varlistentry>
  81         <term>--dbdir-persistent=<parameter>DIRECTORY</parameter></term>
  82         <listitem>
  83           <para>
  84             DIRECTORY on local storage where ctdbd keeps a local copy of
  85             persistent TDB databases.  This directory is local for each
  86             node and should not be stored on the shared cluster
  87             filesystem.
  88           </para>
  89           <para>
  90             Defaults to <filename>/usr/local/var/lib/ctdb/persistent</filename>.
  91           </para>
  92         </listitem>
  93       </varlistentry>
  94
  95       <varlistentry>
  96         <term>--dbdir-state=<parameter>DIRECTORY</parameter></term>
  97         <listitem>
  98           <para>
  99             DIRECTORY on local storage where ctdbd keep internal state
 100             TDB files.  This directory is local for each node and
 101             should not be stored on the shared cluster filesystem.
 102           </para>
 103           <para>
 104             Defaults to <filename>/usr/local/var/lib/ctdb/state</filename>.
 105           </para>
 106         </listitem>
 107       </varlistentry>
 108
 109       <varlistentry>
 110         <term>--event-script-dir=<parameter>DIRECTORY</parameter></term>
 111         <listitem>
 112           <para>
 113             DIRECTORY where the CTDB event scripts are stored.  See the
 114             <citetitle>EVENT SCRIPTS</citetitle> section in
 115             <citerefentry><refentrytitle>ctdb</refentrytitle>
 116             <manvolnum>7</manvolnum></citerefentry> for more information.
 117           </para>
 118           <para>
 119             Default is <envar>CTDB_BASE</envar>/events.d, so usually
 120             <filename>/usr/local/etc/ctdb/events.d</filename>, which is part of
 121             the CTDB installation.
 122           </para>
 123         </listitem>
 124       </varlistentry>
 125
 126       <varlistentry>
 127         <term>--listen=<parameter>IPADDR</parameter></term>
 128         <listitem>
 129           <para>
 130             IPADDR is the private IP address that ctdbd will bind to.
 131           </para>
 132           <para>
 133             By default ctdbd will select the first address from the
 134             nodes list that in can bind to.  See also
 135             <citetitle>--nlist</citetitle>.
 136           </para>
 137           <para>
 138             This option is only required when automatic address
 139             detection can not be used.  This can be the case when
 140             running multiple ctdbd daemons/nodes on the same physical
 141             host (usually for testing), using InfiniBand for the
 142             private network or on Linux when sysctl
 143             net.ipv4.ip_nonlocal_bind=1.
 144           </para>
 145         </listitem>
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term>--logging=<parameter>STRING</parameter></term>
 150         <listitem>
 151           <para>
 152             STRING specifies where ctdbd will write its log. The
 153             default is
 154             file:<filename>/usr/local/var/log/log.ctdb</filename>.
 155           </para>
 156           <para>
 157             Valid values are:
 158           </para>
 159           <variablelist>
 160             <varlistentry>
 161               <term>file:<parameter>FILENAME</parameter></term>
 162               <listitem>
 163                 <para>
 164                   FILENAME where ctdbd will write its log. This is usually
 165                   <filename>/usr/local/var/log/log.ctdb</filename>.
 166                 </para>
 167               </listitem>
 168             </varlistentry>
 169             <varlistentry>
 170               <term>syslog<optional>:<parameter>METHOD</parameter></optional></term>
 171               <listitem>
 172                 <para>
 173                   CTDB will log to syslog.  By default this will use
 174                   the syslog(3) API.
 175                 </para>
 176                 <para>
 177                   Under heavy loads syslog(3) can block if the syslog
 178                   daemon processes messages too slowly.  This can
 179                   cause CTDB to block when logging.
 180                 </para>
 181                 <para>
 182                   If METHOD is specified then it specifies an
 183                   extension that causes logging to be done in a
 184                   non-blocking mode.  Note that <emphasis>this may
 185                   cause messages to be dropped</emphasis>.  METHOD
 186                   must be one of:
 187                 </para>
 188                 <variablelist>
 189                   <varlistentry>
 190                     <term>nonblocking</term>
 191                     <listitem>
 192                       <para>
 193                         CTDB will log to syslog via
 194                         <filename>/dev/log</filename> in non-blocking
 195                         mode.
 196                       </para>
 197                     </listitem>
 198                   </varlistentry>
 199                   <varlistentry>
 200                     <term>udp</term>
 201                     <listitem>
 202                       <para>
 203                         CTDB will log to syslog via UDP to
 204                         localhost:514.  The syslog daemon must be
 205                         configured to listen on (at least)
 206                         localhost:514.  Most syslog daemons will log
 207                         the messages with hostname "localhost" - this
 208                         is a limitation of the implementation, for
 209                         compatibility with more syslog daemons.
 210                       </para>
 211                     </listitem>
 212                   </varlistentry>
 213                   <varlistentry>
 214                     <term>udp-rfc5424</term>
 215                     <listitem>
 216                       <para>
 217                         As with "udp" but messages are sent in RFC5424
 218                         format.  This method will log the correct
 219                         hostname but is not as widely implemented in
 220                         syslog daemons.
 221                       </para>
 222                     </listitem>
 223                   </varlistentry>
 224                 </variablelist>
 225               </listitem>
 226             </varlistentry>
 227           </variablelist>
 228         </listitem>
 229       </varlistentry>
 230
 231       <varlistentry>
 232         <term>--max-persistent-check-errors=<parameter>NUM</parameter></term>
 233         <listitem>
 234           <para>
 235             NUM specifies the maximum number of health check failures
 236             allowed for persistent databases during startup.
 237           </para>
 238           <para>
 239             The default value is 0.  Setting this to non-zero allows a
 240             node with unhealthy persistent databases to startup and
 241             join the cluster as long as there is another node with
 242             healthy persistent databases.
 243           </para>
 244         </listitem>
 245       </varlistentry>
 246
 247       <varlistentry>
 248         <term>--nlist=<parameter>FILENAME</parameter></term>
 249         <listitem>
 250           <para>
 251             FILENAME containing a list of the private IP addresses, one
 252             per line, for each node in the cluster.  This file
 253             <emphasis>must be the same on each node</emphasis> in the
 254             cluster.
 255           </para>
 256           <para>
 257             Default is <envar>CTDB_BASE</envar>/nodes, so usually
 258             <filename>/usr/local/etc/ctdb/nodes</filename>.
 259           </para>
 260         </listitem>
 261       </varlistentry>
 262
 263       <varlistentry>
 264         <term>--no-lmaster</term>
 265         <listitem>
 266           <para>
 267             This argument specifies that this node can NOT become an lmaster
 268             for records in the database. This means that it will never show up
 269             in the vnnmap. This feature is primarily used for making a cluster
 270             span across a WAN link and use CTDB as a WAN-accelerator.
 271           </para>
 272           <para>
 273             Please see the <citetitle>REMOTE CLUSTER NODES</citetitle>
 274             section in <citerefentry><refentrytitle>ctdb</refentrytitle>
 275             <manvolnum>7</manvolnum></citerefentry> for more
 276             information.
 277           </para>
 278         </listitem>
 279       </varlistentry>
 280
 281       <varlistentry>
 282         <term>--no-recmaster</term>
 283         <listitem>
 284           <para>
 285             This argument specifies that this node can NOT become a recmaster
 286             for the database. This feature is primarily used for making a cluster
 287             span across a WAN link and use CTDB as a WAN-accelerator.
 288           </para>
 289           <para>
 290             Please see the <citetitle>REMOTE CLUSTER NODES</citetitle>
 291             section in <citerefentry><refentrytitle>ctdb</refentrytitle>
 292             <manvolnum>7</manvolnum></citerefentry> for more
 293             information.
 294           </para>
 295         </listitem>
 296       </varlistentry>
 297
 298       <varlistentry>
 299         <term>--notification-script=<parameter>FILENAME</parameter></term>
 300         <listitem>
 301           <para>
 302             FILENAME specifying a script to be invoked by ctdbd when
 303             certain state changes occur.
 304           </para>
 305           <para>
 306             This file is usually
 307             <filename>/usr/local/etc/ctdb/notify.sh</filename>.
 308           </para>
 309           <para>
 310             Please see the <citetitle>NOTIFICATION SCRIPT</citetitle>
 311             section in <citerefentry><refentrytitle>ctdb</refentrytitle>
 312             <manvolnum>7</manvolnum></citerefentry> for more
 313             information.
 314           </para>
 315         </listitem>
 316       </varlistentry>
 317
 318       <varlistentry>
 319         <term>--public_addresses=<parameter>FILENAME</parameter></term>
 320         <listitem>
 321           <para>
 322             FILENAME specifying a file containing the public IP
 323             addresses to use on the cluster when CTDB should use IP
 324             takeover. This file contains a list of IP addresses,
 325             netmasks and interfaces.  CTDB will distribute these public
 326             IP addresses appropriately across the available nodes.
 327           </para>
 328           <para>
 329             The IP addresses specified in this file can differ across
 330             nodes.
 331           </para>
 332           <para>
 333             This is usually the file
 334             <filename>/usr/local/etc/ctdb/public_addresses</filename>
 335           </para>
 336         </listitem>
 337       </varlistentry>
 338
 339       <varlistentry>
 340         <term>--public-interface=<parameter>INTERFACE</parameter></term>
 341         <listitem>
 342           <para>
 343             Default INTERFACE on which to attach public IP addresses.
 344           </para>
 345           <para>
 346             When using public IP addresses, this is only required if
 347             interfaces are not explicitly specified in the public
 348             addresses file.
 349           </para>
 350         </listitem>
 351       </varlistentry>
 352
 353       <varlistentry>
 354         <term>--reclock=<parameter>LOCK</parameter></term>
 355         <listitem>
 356           <para>
 357             LOCK specifies the cluster-wide mutex used to detect and
 358             prevent a partitioned cluster (or "split brain").
 359           </para>
 360           <para>
 361             For information about the recovery lock please see the
 362             <citetitle>RECOVERY LOCK</citetitle> section in
 363             <citerefentry><refentrytitle>ctdb</refentrytitle>
 364             <manvolnum>7</manvolnum></citerefentry>.
 365           </para>
 366         </listitem>
 367       </varlistentry>
 368
 369       <varlistentry>
 370         <term>--start-as-disabled</term>
 371         <listitem>
 372           <para>
 373             This makes ctdbd start in the DISABLED state.
 374           </para>
 375           <para>
 376             To allow the node to host public IP addresses and
 377             services, it must be manually enabled using the
 378             <command>ctdb enable</command> command.
 379           </para>
 380           <para>
 381             Please see the <citetitle>NODE STATES</citetitle> section
 382             in <citerefentry><refentrytitle>ctdb</refentrytitle>
 383             <manvolnum>7</manvolnum></citerefentry> for more
 384             information about the DISABLED state.
 385           </para>
 386         </listitem>
 387       </varlistentry>
 388
 389       <varlistentry>
 390         <term>--start-as-stopped</term>
 391         <listitem>
 392           <para>
 393             This makes ctdbd start in the STOPPED state.
 394           </para>
 395           <para>
 396             To allow the node to take part in the cluster it must be
 397             manually continued with the the <command>ctdb
 398             enable</command> command.
 399           </para>
 400           <para>
 401             Please see the <citetitle>NODE STATES</citetitle> section
 402             in <citerefentry><refentrytitle>ctdb</refentrytitle>
 403             <manvolnum>7</manvolnum></citerefentry> for more
 404             information about the STOPPED state.
 405           </para>
 406         </listitem>
 407       </varlistentry>
 408
 409       <varlistentry>
 410         <term>--transport=tcp|infiniband</term>
 411         <listitem>
 412           <para>
 413             This option specifies which transport to use for ctdbd
 414             internode communications. The default is "tcp".
 415           </para>
 416           <para>
 417             The "infiniband" support is not regularly tested.
 418           </para>
 419         </listitem>
 420       </varlistentry>
 421
 422       <varlistentry>
 423         <term>-?, --help</term>
 424         <listitem>
 425           <para>
 426             Display a summary of options.
 427           </para>
 428         </listitem>
 429       </varlistentry>
 430
 431     </variablelist>
 432   </refsect1>
 433
 434   <refsect1>
 435     <title>DEBUGGING OPTIONS</title>
 436
 437     <variablelist>
 438
 439       <varlistentry>
 440         <term>-i, --interactive</term>
 441         <listitem>
 442           <para>
 443             Enable interactive mode.  This will make ctdbd run in the
 444             foreground and not detach from the terminal.  By default
 445             ctdbd will detach itself and run in the background as a
 446             daemon.
 447           </para>
 448         </listitem>
 449       </varlistentry>
 450
 451       <varlistentry>
 452         <term>--nopublicipcheck</term>
 453         <listitem>
 454           <para>
 455             This option is used when testing with multiple local
 456             daemons on a single machine.  It disables checks related
 457             to public IP addresses.
 458           </para>
 459         </listitem>
 460       </varlistentry>
 461
 462       <varlistentry>
 463         <term>--nosetsched</term>
 464         <listitem>
 465           <para>
 466             This is a debugging option. This option is only used when
 467             debugging ctdbd.
 468           </para>
 469           <para>
 470             Normally ctdbd will change its scheduler to run as a
 471             real-time process. This is the default mode for a normal
 472             ctdbd operation to gurarantee that ctdbd always gets the CPU
 473             cycles that it needs.
 474           </para>
 475           <para>
 476             This option is used to tell ctdbd to
 477             <emphasis>not</emphasis> run as a real-time process and
 478             instead run ctdbd as a normal userspace process.  This is
 479             useful for debugging and when you want to run ctdbd under
 480             valgrind or gdb. (You don't want to attach valgrind or gdb
 481             to a real-time process.)
 482           </para>
 483         </listitem>
 484       </varlistentry>
 485
 486       <varlistentry>
 487         <term>--socket=<parameter>FILENAME</parameter></term>
 488         <listitem>
 489           <para>
 490             FILENAME specifies the name of the Unix domain socket that
 491             ctdbd will create. This socket is used by local clients to
 492             communicate with ctdbd.
 493           </para>
 494           <para>
 495             The default is <filename>/usr/local/var/run/ctdb/ctdbd.socket</filename>.
 496             You only need to use this option if you plan to run
 497             multiple ctdbd daemons on the same physical host, usually
 498             for testing.
 499           </para>
 500         </listitem>
 501       </varlistentry>
 502
 503       <varlistentry>
 504         <term>--script-log-level=<parameter>DEBUGLEVEL</parameter></term>
 505         <listitem>
 506           <para>
 507             This option sets the debug level of event script output to
 508             DEBUGLEVEL.  The default is ERR.
 509           </para>
 510           <para>
 511             See the <citetitle>DEBUG LEVELS</citetitle> section in
 512             <citerefentry><refentrytitle>ctdb</refentrytitle>
 513             <manvolnum>7</manvolnum></citerefentry> for more
 514             information.
 515           </para>
 516         </listitem>
 517       </varlistentry>
 518
 519       <varlistentry>
 520         <term>--sloppy-start</term>
 521         <listitem>
 522           <para>
 523             This is debugging option.  This speeds up the initial
 524             recovery during startup at the expense of some consistency
 525             checking.  <emphasis>Don't use this option in
 526             production</emphasis>.
 527           </para>
 528         </listitem>
 529       </varlistentry>
 530
 531       <varlistentry>
 532         <term>--torture</term>
 533         <listitem>
 534           <para>
 535             This option is only used for development and testing of
 536             CTDB.  It adds artificial errors and failures to the
 537             common codepaths in ctdbd to verify that ctdbd can recover
 538             correctly from failures.
 539           </para>
 540           <para>
 541             <emphasis>Do not use this option</emphasis> unless you are
 542             developing and testing new functionality in CTDB.
 543           </para>
 544         </listitem>
 545       </varlistentry>
 546
 547       <varlistentry>
 548         <term>--valgrinding</term>
 549         <listitem>
 550           <para>
 551             This is a debugging option. This option is only used when
 552             debugging ctdbd.  This enables additional debugging
 553             capabilities and implies --nosetsched.
 554           </para>
 555         </listitem>
 556       </varlistentry>
 557
 558     </variablelist>
 559   </refsect1>
 560
 561   <refsect1>
 562     <title>SEE ALSO</title>
 563     <para>
 564       <citerefentry><refentrytitle>ctdb</refentrytitle>
 565       <manvolnum>1</manvolnum></citerefentry>,
 566
 567       <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
 568       <manvolnum>1</manvolnum></citerefentry>,
 569
 570       <citerefentry><refentrytitle>onnode</refentrytitle>
 571       <manvolnum>1</manvolnum></citerefentry>,
 572
 573       <citerefentry><refentrytitle>ctdb</refentrytitle>
 574       <manvolnum>7</manvolnum></citerefentry>,
 575
 576       <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
 577       <manvolnum>7</manvolnum></citerefentry>,
 578
 579       <ulink url="http://ctdb.samba.org/"/>
 580     </para>
 581   </refsect1>
 582
 583   <refentryinfo>
 584     <author>
 585       <contrib>
 586         This documentation was written by
 587         Ronnie Sahlberg,
 588         Amitay Isaacs,
 589         Martin Schwenke
 590       </contrib>
 591     </author>
 592
 593     <copyright>
 594       <year>2007</year>
 595       <holder>Andrew Tridgell</holder>
 596       <holder>Ronnie Sahlberg</holder>
 597     </copyright>
 598     <legalnotice>
 599       <para>
 600         This program is free software; you can redistribute it and/or
 601         modify it under the terms of the GNU General Public License as
 602         published by the Free Software Foundation; either version 3 of
 603         the License, or (at your option) any later version.
 604       </para>
 605       <para>
 606         This program is distributed in the hope that it will be
 607         useful, but WITHOUT ANY WARRANTY; without even the implied
 608         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 609         PURPOSE.  See the GNU General Public License for more details.
 610       </para>
 611       <para>
 612         You should have received a copy of the GNU General Public
 613         License along with this program; if not, see
 614         <ulink url="http://www.gnu.org/licenses"/>.
 615       </para>
 616     </legalnotice>
 617   </refentryinfo>
 618
 619 </refentry>