ctdb/doc/ctdbd.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="ctdbd.1">
   4
   5 <refmeta>
   6         <refentrytitle>ctdbd</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>ctdbd</refname>
  13         <refpurpose>The CTDB cluster daemon</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>ctdbd</command>
  19         </cmdsynopsis>
  20
  21         <cmdsynopsis>
  22                 <command>ctdbd</command>
  23                 <arg choice="opt">-? --help</arg>
  24                 <arg choice="opt">-d --debug=&lt;INTEGER&gt;</arg>
  25                 <arg choice="req">--dbdir=&lt;directory&gt;</arg>
  26                 <arg choice="req">--dbdir-persistent=&lt;directory&gt;</arg>
  27                 <arg choice="opt">--event-script-dir=&lt;directory&gt;</arg>
  28                 <arg choice="opt">-i --interactive</arg>
  29                 <arg choice="opt">--listen=&lt;address&gt;</arg>
  30                 <arg choice="opt">--logfile=&lt;filename&gt;</arg>
  31                 <arg choice="opt">--lvs</arg>
  32                 <arg choice="req">--nlist=&lt;filename&gt;</arg>
  33                 <arg choice="opt">--no-lmaster</arg>
  34                 <arg choice="opt">--no-recmaster</arg>
  35                 <arg choice="opt">--nosetsched</arg>
  36                 <arg choice="opt">--public-addresses=&lt;filename&gt;</arg>
  37                 <arg choice="opt">--public-interface=&lt;interface&gt;</arg>
  38                 <arg choice="req">--reclock=&lt;filename&gt;</arg>
  39                 <arg choice="opt">--single-public-ip=&lt;address&gt;</arg>
  40                 <arg choice="opt">--socket=&lt;filename&gt;</arg>
  41                 <arg choice="opt">--start-as-disabled</arg>
  42                 <arg choice="opt">--start-as-stopped</arg>
  43                 <arg choice="opt">--syslog</arg>
  44                 <arg choice="opt">--torture</arg>
  45                 <arg choice="opt">--transport=&lt;STRING&gt;</arg>
  46                 <arg choice="opt">--usage</arg>
  47         </cmdsynopsis>
  48
  49 </refsynopsisdiv>
  50
  51   <refsect1><title>DESCRIPTION</title>
  52     <para>
  53       ctdbd is the main ctdb daemon.
  54     </para>
  55     <para>
  56       ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
  57     </para>
  58     <para>
  59       Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services.
  60     </para>
  61     <para>
  62       ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
  63     </para>
  64     <para>
  65       ctdbd is the main component in clustered Samba that provides a high-availability load-sharing CIFS server cluster.
  66     </para>
  67   </refsect1>
  68
  69
  70   <refsect1>
  71     <title>OPTIONS</title>
  72
  73     <variablelist>
  74       <varlistentry><term>-? --help</term>
  75         <listitem>
  76           <para>
  77             Print some help text to the screen.
  78           </para>
  79         </listitem>
  80       </varlistentry>
  81
  82       <varlistentry><term>-d --debug=&lt;DEBUGLEVEL&gt;</term>
  83         <listitem>
  84           <para>
  85             This option sets the debuglevel on the ctdbd daemon which controls what will be written to the logfile. The default is 0 which will only log important events and errors. A larger number will provide additional logging.
  86           </para>
  87         </listitem>
  88       </varlistentry>
  89
  90       <varlistentry><term>--dbdir=&lt;directory&gt;</term>
  91         <listitem>
  92           <para>
  93             This is the directory on local storage where ctdbd keeps the local
  94             copy of the TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
  95           </para>
  96           <para>
  97             This directory would usually be /var/ctdb .
  98           </para>
  99         </listitem>
 100       </varlistentry>
 101
 102       <varlistentry><term>--dbdir-persistent=&lt;directory&gt;</term>
 103         <listitem>
 104           <para>
 105             This is the directory on local storage where ctdbd keeps the local
 106             copy of the persistent TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
 107           </para>
 108           <para>
 109             This directory would usually be /etc/ctdb/persistent .
 110           </para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry><term>--event-script-dir=&lt;directory&gt;</term>
 115         <listitem>
 116           <para>
 117             This option is used to specify the directory where the CTDB event
 118             scripts are stored.
 119           </para>
 120           <para>
 121             This will normally be /etc/ctdb/events.d which is part of the ctdb distribution.
 122           </para>
 123         </listitem>
 124       </varlistentry>
 125
 126       <varlistentry><term>-i --interactive</term>
 127         <listitem>
 128           <para>
 129             By default ctdbd will detach itself from the shell and run in
 130             the background as a daemon. This option makes ctdbd to start in interactive mode.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134
 135       <varlistentry><term>--listen=&lt;address&gt;</term>
 136         <listitem>
 137           <para>
 138             This specifies which ip address ctdb will bind to. By default ctdbd will bind to the first address it finds in the /etc/ctdb/nodes file and which is also present on the local system in which case you do not need to provide this option.
 139           </para>
 140           <para>
 141             This option is only required when you want to run multiple ctdbd daemons/nodes on the same physical host in which case there would be multiple entries in /etc/ctdb/nodes what would match a local interface.
 142           </para>
 143         </listitem>
 144       </varlistentry>
 145
 146       <varlistentry><term>--logfile=&lt;filename&gt;</term>
 147         <listitem>
 148           <para>
 149             This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
 150           </para>
 151         </listitem>
 152       </varlistentry>
 153
 154       <varlistentry><term>--lvs</term>
 155         <listitem>
 156           <para>
 157           This option is used to activate the LVS capability on a CTDB node.
 158           Please see the LVS section.
 159           </para>
 160         </listitem>
 161       </varlistentry>
 162
 163       <varlistentry><term>--nlist=&lt;filename&gt;</term>
 164         <listitem>
 165           <para>
 166             This file contains a list of the private ip addresses of every node in the cluster. There is one line/ip address for each node. This file must be the same for all nodes in the cluster.
 167           </para>
 168           <para>
 169             This file is usually /etc/ctdb/nodes .
 170           </para>
 171         </listitem>
 172       </varlistentry>
 173
 174       <varlistentry><term>--no-lmaster</term>
 175         <listitem>
 176           <para>
 177           This argument specifies that this node can NOT become an lmaster
 178           for records in the database. This means that it will never show up
 179           in the vnnmap. This feature is primarily used for making a cluster
 180         span across a WAN link and use CTDB as a WAN-accelerator.
 181           </para>
 182           <para>
 183           Please see the "remote cluster nodes" section for more information.
 184           </para>
 185         </listitem>
 186       </varlistentry>
 187
 188       <varlistentry><term>--no-recmaster</term>
 189         <listitem>
 190           <para>
 191           This argument specifies that this node can NOT become a recmaster
 192           for the database. This feature is primarily used for making a cluster
 193         span across a WAN link and use CTDB as a WAN-accelerator.
 194           </para>
 195           <para>
 196           Please see the "remote cluster nodes" section for more information.
 197           </para>
 198         </listitem>
 199       </varlistentry>
 200
 201       <varlistentry><term>--nosetsched</term>
 202         <listitem>
 203           <para>
 204             This is a ctdbd debugging option. this option is only used when
 205             debugging ctdbd.
 206           </para>
 207           <para>
 208             Normally ctdb will change its scheduler to run as a real-time
 209             process. This is the default mode for a normal ctdbd operation
 210             to gurarantee that ctdbd always gets the cpu cycles that it needs.
 211           </para>
 212           <para>
 213             This option is used to tell ctdbd to NOT run as a real-time process
 214             and instead run ctdbd as a normal userspace process.
 215             This is useful for debugging and when you want to run ctdbd under
 216             valgrind or gdb. (You dont want to attach valgrind or gdb to a
 217             real-time process.)
 218           </para>
 219         </listitem>
 220       </varlistentry>
 221
 222       <varlistentry><term>--public_addresses=&lt;filename&gt;</term>
 223         <listitem>
 224           <para>
 225             When used with IP takeover this specifies a file containing the public ip addresses to use on the cluster. This file contains a list of ip addresses netmasks and interfaces. When ctdb is operational it will distribute these public ip addresses evenly across the available nodes.
 226           </para>
 227           <para>
 228             This is usually the file /etc/ctdb/public_addresses
 229           </para>
 230         </listitem>
 231       </varlistentry>
 232
 233       <varlistentry><term>--public-interface=&lt;interface&gt;</term>
 234         <listitem>
 235           <para>
 236             This option tells ctdb which interface to attach public-addresses
 237             to and also where to attach the single-public-ip when used.
 238             </para>
 239             <para>
 240             This is only required when using public ip addresses and only when
 241             you dont specify the interface explicitly in /etc/ctdb/public_addresses or when you are using --single-public-ip.
 242           </para>
 243           <para>
 244           If you omit this argument when using public addresses or single public ip, ctdb will not be able to send out Gratious ARPs correctly or be able to kill tcp connections correctly which will lead to application failures.
 245           </para>
 246         </listitem>
 247       </varlistentry>
 248
 249       <varlistentry><term>--reclock=&lt;filename&gt;</term>
 250         <listitem>
 251           <para>
 252             This is the name of the lock file stored of the shared cluster filesystem that ctdbd uses to prevent split brains from occuring.
 253             This file must be stored on shared storage.
 254           </para>
 255           <para>
 256             It is possible to run CTDB without a reclock file, but then there
 257             will be no protection against split brain if the network becomes
 258             partitioned. Using CTDB without a reclock file is strongly
 259             discouraged.
 260           </para>
 261         </listitem>
 262       </varlistentry>
 263
 264       <varlistentry><term>--socket=&lt;filename&gt;</term>
 265         <listitem>
 266           <para>
 267             This specifies the name of the domain socket that ctdbd will create. This socket is used for local clients to attach to and communicate with the ctdbd daemon.
 268           </para>
 269           <para>
 270             The default is /tmp/ctdb.socket . You only need to use this option if you plan to run multiple ctdbd daemons on the same physical host.
 271           </para>
 272         </listitem>
 273       </varlistentry>
 274
 275       <varlistentry><term>--start-as-disabled</term>
 276         <listitem>
 277           <para>
 278           This makes the ctdb daemon to be DISABLED when it starts up.
 279           </para>
 280           <para>
 281           As it is DISABLED it will not get any of the public ip addresses
 282           allocated to it, and thus this allow you to start ctdb on a node
 283           without causing any ip address to failover from other nodes onto
 284           the new node.
 285           </para>
 286           <para>
 287           When used, the administrator must keep track of when nodes start and
 288           manually enable them again using the "ctdb enable" command, or else
 289           the node will not host any services.
 290           </para>
 291           <para>
 292           A node that is DISABLED will not host any services and will not be
 293           reachable/used by any clients.
 294           </para>
 295         </listitem>
 296       </varlistentry>
 297
 298       <varlistentry><term>--start-as-stopped</term>
 299         <listitem>
 300           <para>
 301           This makes the ctdb daemon to be STOPPED when it starts up.
 302           </para>
 303           <para>
 304           A node that is STOPPED does not host any public addresses. It is not part of the VNNMAP so it does act as an LMASTER. It also has all databases locked in recovery mode until restarted.
 305           </para>
 306           <para>
 307           To restart and activate a STOPPED node, the command "ctdb continue" is used.
 308           </para>
 309           <para>
 310           A node that is STOPPED will not host any services and will not be
 311           reachable/used by any clients.
 312           </para>
 313         </listitem>
 314       </varlistentry>
 315
 316       <varlistentry><term>--syslog</term>
 317         <listitem>
 318           <para>
 319             Send all log messages to syslog instead of to the ctdb logfile.
 320           </para>
 321         </listitem>
 322       </varlistentry>
 323
 324       <varlistentry><term>--torture</term>
 325         <listitem>
 326           <para>
 327             This option is only used for development and testing of ctdbd. It adds artificial errors and failures to the common codepaths in ctdbd to verify that ctdbd can recover correctly for failures.
 328           </para>
 329           <para>
 330             You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
 331           </para>
 332         </listitem>
 333       </varlistentry>
 334
 335       <varlistentry><term>--transport=&lt;STRING&gt;</term>
 336         <listitem>
 337           <para>
 338             This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
 339           </para>
 340           <para>
 341             Currently only "tcp" is supported but "infiniband" might be
 342             implemented in the future.
 343           </para>
 344         </listitem>
 345       </varlistentry>
 346
 347       <varlistentry><term>--usage</term>
 348         <listitem>
 349           <para>
 350             Print useage information to the screen.
 351           </para>
 352         </listitem>
 353       </varlistentry>
 354
 355     </variablelist>
 356   </refsect1>
 357
 358
 359   <refsect1><title>Private vs Public addresses</title>
 360     <para>
 361       When used for ip takeover in a HA environment, each node in a ctdb
 362       cluster has multiple ip addresses assigned to it. One private and one or more public.
 363     </para>
 364
 365     <refsect2><title>Private address</title>
 366       <para>
 367         This is the physical ip address of the node which is configured in
 368         linux and attached to a physical interface. This address uniquely
 369         identifies a physical node in the cluster and is the ip addresses
 370         that ctdbd will use to communicate with the ctdbd daemons on the
 371         other nodes in the cluster.
 372       </para>
 373       <para>
 374         The private addresses are configured in /etc/ctdb/nodes
 375         (unless the --nlist option is used) and contain one line for each
 376         node in the cluster. Each line contains the private ip address for one
 377         node in the cluster. This file must be the same on all nodes in the
 378         cluster.
 379       </para>
 380       <para>
 381         Since the private addresses are only available to the network when the
 382         corresponding node is up and running you should not use these addresses
 383         for clients to connect to services provided by the cluster. Instead
 384         client applications should only attach to the public addresses since
 385         these are guaranteed to always be available.
 386       </para>
 387       <para>
 388         When using ip takeover, it is strongly recommended that the private
 389         addresses are configured on a private network physically separated
 390         from the rest of the network and that this private network is dedicated
 391         to CTDB traffic.
 392       </para>
 393       Example /etc/ctdb/nodes for a four node cluster:
 394       <screen format="linespecific">
 395         10.1.1.1
 396         10.1.1.2
 397         10.1.1.3
 398         10.1.1.4
 399       </screen>
 400     </refsect2>
 401     <refsect2><title>Public address</title>
 402       <para>
 403         A public address on the other hand is not attached to an interface.
 404         This address is managed by ctdbd itself and is attached/detached to
 405         a physical node at runtime.
 406       </para>
 407       <para>
 408         The ctdb cluster will assign/reassign these public addresses across the
 409         available healthy nodes in the cluster. When one node fails, its public address
 410         will be migrated to and taken over by a different node in the cluster
 411         to ensure that all public addresses are always available to clients as
 412         long as there are still nodes available capable of hosting this address.
 413       </para>
 414       <para>
 415         These addresses are not physically attached to a specific node.
 416         The 'ctdb ip' command can be used to view the current assignment of
 417         public addresses and which physical node is currently serving it.
 418       </para>
 419       <para>
 420         On each node this file contains a list of the public addresses that
 421         this node is capable of hosting.
 422         The list also contain the netmask and the
 423         interface where this address should be attached for the case where you
 424         may want to serve data out through multiple different interfaces.
 425       </para>
 426       Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
 427       <screen format="linespecific">
 428         11.1.1.1/24 eth0
 429         11.1.1.2/24 eth0
 430         11.1.2.1/24 eth1
 431         11.1.2.2/24 eth1
 432       </screen>
 433
 434         <para>
 435         In most cases this file would be the same on all nodes in a cluster but
 436         there are exceptions when one may want to use different files
 437         on different nodes.
 438         </para>
 439         Example: 4 nodes partitioned into two subgroups :
 440         <screen format="linespecific">
 441         Node 0:/etc/ctdb/public_addresses
 442                 10.1.1.1/24 eth0
 443                 10.1.1.2/24 eth0
 444
 445         Node 1:/etc/ctdb/public_addresses
 446                 10.1.1.1/24 eth0
 447                 10.1.1.2/24 eth0
 448
 449         Node 2:/etc/ctdb/public_addresses
 450                 10.2.1.1/24 eth0
 451                 10.2.1.2/24 eth0
 452
 453         Node 3:/etc/ctdb/public_addresses
 454                 10.2.1.1/24 eth0
 455                 10.2.1.2/24 eth0
 456         </screen>
 457         <para>
 458         In this example nodes 0 and 1 host two public addresses on the
 459         10.1.1.x network  while nodes 2 and 3 host two public addresses for the
 460         10.2.1.x network.
 461         </para>
 462         <para>
 463         Ip address 10.1.1.1 can be hosted by either of nodes 0 or 1 and will be
 464         available to clients as long as at least one of these two nodes are
 465         available.
 466         If both nodes 0 and node 1 become unavailable 10.1.1.1 also becomes
 467         unavailable. 10.1.1.1 can not be failed over to node 2 or node 3 since
 468         these nodes do not have this ip address listed in their public
 469         addresses file.
 470         </para>
 471     </refsect2>
 472   </refsect1>
 473
 474
 475   <refsect1><title>Node status</title>
 476     <para>
 477       The current status of each node in the cluster can be viewed by the
 478       'ctdb status' command.
 479     </para>
 480     <para>
 481       There are five possible states for a node.
 482     </para>
 483
 484     <para>
 485       OK - This node is fully functional.
 486     </para>
 487
 488     <para>
 489       DISCONNECTED - This node could not be connected through the network
 490       and is currently not particpating in the cluster. If there is a
 491       public IP address associated with this node it should have been taken
 492       over by a different node. No services are running on this node.
 493     </para>
 494
 495     <para>
 496       DISABLED - This node has been administratively disabled. This node is
 497       still functional and participates in the CTDB cluster but its IP
 498       addresses have been taken over by a different node and no services are
 499       currently being hosted.
 500     </para>
 501
 502     <para>
 503       UNHEALTHY - A service provided by this node is malfunctioning and should
 504       be investigated. The CTDB daemon itself is operational and participates
 505       in the cluster. Its public IP address has been taken over by a different
 506       node and no services are currently being hosted. All unhealthy nodes
 507       should be investigated and require an administrative action to rectify.
 508     </para>
 509
 510     <para>
 511       BANNED - This node failed too many recovery attempts and has been banned
 512       from participating in the cluster for a period of RecoveryBanPeriod
 513       seconds. Any public IP address has been taken over by other nodes. This
 514       node does not provide any services. All banned nodes should be
 515       investigated and require an administrative action to rectify. This node
 516       does not perticipate in the CTDB cluster but can still be communicated
 517       with. I.e. ctdb commands can be sent to it.
 518     </para>
 519
 520     <para>
 521       STOPPED - A node that is stopped does not host any public ip addresses,
 522       nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
 523       RECMASTER or NATGW.
 524       This node does not perticipate in the CTDB cluster but can still be
 525       communicated with. I.e. ctdb commands can be sent to it.
 526     </para>
 527   </refsect1>
 528
 529   <refsect1>
 530     <title>PUBLIC TUNABLES</title>
 531     <para>
 532     These are the public tuneables that can be used to control how ctdb behaves.
 533     </para>
 534
 535     <refsect2><title>KeepaliveInterval</title>
 536     <para>Default: 1</para>
 537     <para>
 538     How often should the nodes send keepalives to eachother.
 539     </para>
 540     </refsect2>
 541     <refsect2><title>KeepaliveLimit</title>
 542     <para>Default: 5</para>
 543     <para>
 544     After how many keepalive intervals without any traffic should a node
 545     wait until marking the peer as DISCONNECTED.
 546     </para>
 547     </refsect2>
 548     <refsect2><title>MonitorInterval</title>
 549     <para>Default: 15</para>
 550     <para>
 551     How often should ctdb run the event scripts to check for a nodes health.
 552     </para>
 553     </refsect2>
 554     <refsect2><title>TickleUpdateInterval</title>
 555     <para>Default: 20</para>
 556     <para>
 557     How often will ctdb record and store the "tickle" information used to
 558     kickstart stalled tcp connections after a recovery.
 559     </para>
 560     </refsect2>
 561     <refsect2><title>EventScriptTimeout</title>
 562     <para>Default: 20</para>
 563     <para>
 564     How long should ctdb let an event script run before aborting it and
 565     marking the node unhealthy.
 566     </para>
 567     </refsect2>
 568     <refsect2><title>RecoveryBanPeriod</title>
 569     <para>Default: 300</para>
 570     <para>
 571     If a node becomes banned causing repetitive recovery failures. The node will
 572     eventually become banned from the cluster.
 573     This controls how long the culprit node will be banned from the cluster
 574     before it is allowed to try to join the cluster again.
 575     Dont set to small. A node gets banned for a reason and it is usually due
 576     to real problems with the node.
 577     </para>
 578     </refsect2>
 579     <refsect2><title>DatabaseHashSize</title>
 580     <para>Default: 100000</para>
 581     <para>
 582     Size of the hash chains for the local store of the tdbs that ctdb manages.
 583     </para>
 584     </refsect2>
 585     <refsect2><title>RerecoveryTimeout</title>
 586     <para>Default: 10</para>
 587     <para>
 588     Once a recovery has completed, no additional recoveries are permitted until this timeout has expired.
 589     </para>
 590     </refsect2>
 591     <refsect2><title>EnableBans</title>
 592     <para>Default: 1</para>
 593     <para>
 594     When set to 0, this disables BANNING completely in the cluster and thus nodes can not get banned, even it they break. Dont set to 0.
 595     </para>
 596     </refsect2>
 597     <refsect2><title>DeterministicIPs</title>
 598     <para>Default: 1</para>
 599     <para>
 600     When enabled, this tunable makes ctdb try to keep public IP addresses locked to specific nodes as far as possible. This makes it easier for debugging since you can know that as long as all nodes are healthy public IP X will always be hosted by node Y.
 601     </para>
 602     <para>
 603     The cost of using deterministic IP address assignment is that it disables part of the logic where ctdb tries to reduce the number of public IP assignment changes in the cluster. This tunable may increase the number of IP failover/failbacks that are performed on the cluster by a small margin.
 604     </para>
 605     </refsect2>
 606     <refsect2><title>DisableWhenUnhealthy</title>
 607     <para>Default: 0</para>
 608     <para>
 609     When set, As soon as a node becomes unhealthy, that node will also automatically become permanently DISABLED. Once a node is DISABLED, the only way to make it participate in the cluster again and host services is by manually enabling the node again using 'ctdb enable'.
 610     </para>
 611     <para>
 612     This disables parts of the resilience and robustness of the cluster and should ONLY be used when the system administrator is actively monitoring the cluster, so that nodes can be enabled again.
 613     </para>
 614     </refsect2>
 615     <refsect2><title>NoIPFailback</title>
 616     <para>Default: 0</para>
 617     <para>
 618     When set to 1, ctdb will not perform failback of IP addresses when a node becomes healthy. Ctdb WILL perform failover of public IP addresses when a node becomes UNHEALTHY, but when the node becomes HEALTHY again, ctdb will not fail the addresses back.
 619     </para>
 620     <para>
 621     Use with caution! Normally when a node becomes available to the cluster
 622 ctdb will try to reassign public IP addresses onto the new node as a way to distribute the workload evenly across the clusternode. Ctdb tries to make sure that all running nodes have approximately the same number of public addresses it hosts.
 623     </para>
 624     <para>
 625     When you enable this tunable, CTDB will no longer attempt to rebalance the cluster by failing IP addresses back to the new nodes. An unbalanced cluster will therefore remain unbalanced until there is manual intervention from the administrator. When this parameter is set, you can manually fail public IP addresses over to the new node(s) using the 'ctdb moveip' command.
 626     </para>
 627     </refsect2>
 628   </refsect1>
 629
 630   <refsect1><title>LVS</title>
 631     <para>
 632     LVS is a mode where CTDB presents one single IP address for the entire
 633     cluster. This is an alternative to using public IP addresses and round-robin
 634     DNS to loadbalance clients across the cluster.
 635     </para>
 636
 637     <para>
 638     This is similar to using a layer-4 loadbalancing switch but with some restrictions.
 639     </para>
 640
 641     <para>
 642     In this mode the cluster select a set of nodes in the cluster and loadbalance
 643     all client access to the LVS address across this set of nodes. This set of nodes are all LVS capable nodes that are HEALTHY, or if no HEALTHY nodes exists
 644     all LVS capable nodes regardless of health status.
 645     LVS will however never loadbalance traffic to nodes that are BANNED,
 646     STOPPED, DISABLED or DISCONNECTED. The "ctdb lvs" command is used to show
 647     which nodes are currently load-balanced across.
 648     </para>
 649
 650     <para>
 651     One of the these nodes are elected as the LVSMASTER. This node receives all
 652     traffic from clients coming in to the LVS address and multiplexes it
 653     across the internal network to one of the nodes that LVS is using.
 654     When responding to the client, that node will send the data back
 655     directly to the client, bypassing the LVSMASTER node.
 656     The command "ctdb lvsmaster" will show which node is the current
 657     LVSMASTER.
 658     </para>
 659
 660     <para>
 661     The path used for a client i/o is thus :
 662     <screen format="linespecific">
 663         (1) Client sends request packet to LVSMASTER
 664         (2) LVSMASTER passes the request on to one node across the internal network.
 665         (3) Selected node processes the request.
 666         (4) Node responds back to client.
 667     </screen>
 668     </para>
 669
 670     <para>
 671     This means that all incoming traffic to the cluster will pass through
 672     one physical node, which limits scalability. You can send more data to the
 673     LVS address that one physical node can multiplex. This means that you
 674     should not use LVS if your I/O pattern is write-intensive since you will be
 675     limited in the available network bandwidth that node can handle.
 676     LVS does work wery well for read-intensive workloads where only smallish
 677     READ requests are going through the LVSMASTER bottleneck and the majority
 678     of the traffic volume (the data in the read replies) goes straight from
 679     the processing node back to the clients. For read-intensive i/o patterns you can acheive very high throughput rates in this mode.
 680     </para>
 681
 682     <para>
 683     Note: you can use LVS and public addresses at the same time.
 684     </para>
 685
 686     <refsect2><title>Configuration</title>
 687         <para>
 688     To activate LVS on a CTDB node you must specify CTDB_PUBLIC_INTERFACE and
 689     CTDB_LVS_PUBLIC_ADDRESS in /etc/sysconfig/ctdb.
 690         </para>
 691
 692         <para>
 693 You must also specify the "--lvs" command line argument to ctdbd to activete LVS as a capability of the node. This should be done automatically for you by the /etc/init.d/ctdb script.
 694         </para>
 695
 696         <para>
 697         Example:
 698     <screen format="linespecific">
 699         CTDB_PUBLIC_INTERFACE=eth0
 700         CTDB_LVS_PUBLIC_IP=10.0.0.237
 701         </screen>
 702         </para>
 703
 704     </refsect2>
 705
 706     <para>
 707     If you use LVS, you must still have a real/permanent address configured
 708     for the public interface on each node. This address must be routable
 709     and the cluster nodes must be configured so that all traffic back to client
 710     hosts are routed through this interface. This is also required in order
 711     to allow samba/winbind on the node to talk to the domain controller.
 712     (we can not use the lvs IP address to initiate outgoing traffic)
 713     </para>
 714     <para>
 715     I.e. make sure that you can "ping" both the domain controller and also
 716     all of the clients from the node BEFORE you enable LVS. Also make sure
 717     that when you ping these hosts that the traffic is routed out through the
 718     eth0 interface.
 719     </para>
 720   </refsect1>
 721
 722
 723   <refsect1><title>REMOTE CLUSTER NODES</title>
 724     <para>
 725 It is possible to have a CTDB cluster that spans across a WAN link.
 726 For example where you have a CTDB cluster in your datacentre but you also
 727 want to have one additional CTDB node located at a remote branch site.
 728 This is similar to how a WAN accelerator works but with the difference
 729 that while a WAN-accelerator often acts as a Proxy or a MitM, in
 730 the ctdb remote cluster node configuration the Samba instance at the remote site
 731 IS the genuine server, not a proxy and not a MitM, and thus provides 100%
 732 correct CIFS semantics to clients.
 733     </para>
 734
 735     <para>
 736         See the cluster as one single multihomed samba server where one of
 737         the NICs (the remote node) is very far away.
 738     </para>
 739
 740     <para>
 741         NOTE: This does require that the cluster filesystem you use can cope
 742         with WAN-link latencies. Not all cluster filesystems can handle
 743         WAN-link latencies! Whether this will provide very good WAN-accelerator
 744         performance or it will perform very poorly depends entirely
 745         on how optimized your cluster filesystem is in handling high latency
 746         for data and metadata operations.
 747     </para>
 748
 749     <para>
 750         To activate a node as being a remote cluster node you need to set
 751         the following two parameters in /etc/sysconfig/ctdb  for the remote node:
 752         <screen format="linespecific">
 753 CTDB_CAPABILITY_LMASTER=no
 754 CTDB_CAPABILITY_RECMASTER=no
 755         </screen>
 756     </para>
 757
 758     <para>
 759         Verify with the command "ctdb getcapabilities" that that node no longer
 760         has the recmaster or the lmaster capabilities.
 761     </para>
 762
 763   </refsect1>
 764
 765
 766   <refsect1><title>NAT-GW</title>
 767     <para>
 768       Sometimes it is desireable to run services on the CTDB node which will
 769       need to originate outgoing traffic to external servers. This might
 770       be contacting NIS servers, LDAP servers etc. etc.
 771     </para>
 772     <para>
 773       This can sometimes be problematic since there are situations when a
 774       node does not have any public ip addresses assigned. This could
 775       be due to the nobe just being started up and no addresses have been
 776       assigned yet or it could be that the node is UNHEALTHY in which
 777       case all public addresses have been migrated off.
 778     </para>
 779     <para>
 780       If then the service status of CTDB depends on such services being
 781       able to always being able to originate traffic to external resources
 782       this becomes extra troublesome. The node might be UNHEALTHY because
 783       the service can not be reached, and the service can not be reached
 784       because the node is UNHEALTHY.
 785     </para>
 786     <para>
 787       There are two ways to solve this problem. The first is by assigning a
 788       static ip address for one public interface on every node which will allow
 789       every node to be able to route traffic to the public network even
 790       if there are no public addresses assigned to the node.
 791       This is the simplest way but it uses up a lot of ip addresses since you
 792       have to assign both static and also public addresses to each node.
 793     </para>
 794     <refsect2><title>NAT-GW</title>
 795     <para>
 796       A second way is to use the built in NAT-GW feature in CTDB.
 797       With NAT-GW you assign one public NATGW address for each natgw group.
 798       Each NATGW group is a set of nodes in the cluster that shares the same
 799       NATGW address to talk to the outside world. Normally there would only be
 800       one NATGW group spanning the entire cluster, but in situations where one
 801       ctdb cluster spans multiple physical sites it is useful to have one
 802       NATGW group for each of the two sites.
 803     </para>
 804     <para>
 805       There can be multiple NATGW groups in one cluster but each node can only
 806       be member of one NATGW group.
 807     </para>
 808     <para>
 809       In each NATGW group, one of the nodes is designated the NAT Gateway
 810       through which all traffic that is originated by nodes in this group
 811       will be routed through if a public addresses are not available.
 812     </para>
 813     </refsect2>
 814
 815     <refsect2><title>Configuration</title>
 816     <para>
 817       NAT-GW is configured in /etc/sysconfigctdb by setting the following
 818       variables:
 819     </para>
 820     <screen format="linespecific">
 821 # NAT-GW configuration
 822 # Some services running on nthe CTDB node may need to originate traffic to
 823 # remote servers before the node is assigned any IP addresses,
 824 # This is problematic since before the node has public addresses the node might
 825 # not be able to route traffic to the public networks.
 826 # One solution is to have static public addresses assigned with routing
 827 # in addition to the public address interfaces, thus guaranteeing that
 828 # a node always can route traffic to the external network.
 829 # This is the most simple solution but it uses up a large number of
 830 # additional ip addresses.
 831 #
 832 # A more complex solution is NAT-GW.
 833 # In this mode we only need one additional ip address for the cluster from
 834 # the exsternal public network.
 835 # One of the nodes in the cluster is elected to be hosting this ip address
 836 # so it can reach the external services. This node is also configured
 837 # to use NAT MASQUERADING for all traffic from the internal private network
 838 # to the external network. This node is the NAT-GW node.
 839 #
 840 # All other nodes are set up with a default rote with a metric of 10 to point
 841 # to the nat-gw node.
 842 #
 843 # The effect of this is that only when a node does not have a public address
 844 # and thus no proper routes to the external world it will instead
 845 # route all packets through the nat-gw node.
 846 #
 847 # CTDB_NATGW_NODES is the list of nodes that belong to this natgw group.
 848 # You can have multiple natgw groups in one cluster but each node
 849 # can only belong to one single natgw group.
 850 #
 851 # CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
 852 # CTDB_NATGW_PUBLIC_IFACE=eth0
 853 # CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
 854 # CTDB_NATGW_PRIVATE_NETWORK=10.1.1.0/24
 855 # CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
 856     </screen>
 857     </refsect2>
 858
 859     <refsect2><title>CTDB_NATGW_PUBLIC_IP</title>
 860     <para>
 861       This is an ip address in the public network that is used for all outgoing
 862       traffic when the public addresses are not assigned.
 863       This address will be assigned to one of the nodes in the cluster which
 864       will masquerade all traffic for the other nodes.
 865     </para>
 866     <para>
 867       Format of this parameter is IPADDRESS/NETMASK
 868     </para>
 869     </refsect2>
 870
 871     <refsect2><title>CTDB_NATGW_PUBLIC_IFACE</title>
 872     <para>
 873       This is the physical interface where the CTDB_NATGW_PUBLIC_IP will be
 874       assigned to. This should be an interface connected to the public network.
 875     </para>
 876     <para>
 877       Format of this parameter is INTERFACE
 878     </para>
 879     </refsect2>
 880
 881     <refsect2><title>CTDB_NATGW_DEFAULT_GATEWAY</title>
 882     <para>
 883       This is the default gateway to use on the node that is elected to host
 884       the CTDB_NATGW_PUBLIC_IP. This is the default gateway on the public network.
 885     </para>
 886     <para>
 887       Format of this parameter is IPADDRESS
 888     </para>
 889     </refsect2>
 890
 891     <refsect2><title>CTDB_NATGW_PRIVATE_NETWORK</title>
 892     <para>
 893       This is the network/netmask used for the interal private network.
 894     </para>
 895     <para>
 896       Format of this parameter is IPADDRESS/NETMASK
 897     </para>
 898     </refsect2>
 899
 900     <refsect2><title>CTDB_NATGW_NODES</title>
 901     <para>
 902       This is the list of all nodes that belong to the same NATGW group
 903       as this node. The default is /etc/ctdb/natgw_nodes.
 904     </para>
 905     </refsect2>
 906
 907     <refsect2><title>Operation</title>
 908     <para>
 909       When the NAT-GW functionality is used, one of the nodes is elected
 910       to act as a NAT router for all the other nodes in the group when
 911       they need to originate traffic to the external public network.
 912     </para>
 913     <para>
 914       The NAT-GW node is assigned the CTDB_NATGW_PUBLIC_IP to the designated
 915       interface and the provided default route. The NAT-GW is configured
 916       to act as a router and to masquerade all traffic it receives from the
 917       internal private network and which is destined to the external network(s).
 918     </para>
 919     <para>
 920       All other nodes in the group are configured with a default route of
 921       metric 10 pointing to the designated NAT GW node.
 922     </para>
 923     <para>
 924       This is implemented in the 11.natgw eventscript. Please see the
 925       eventscript for further information.
 926     </para>
 927
 928     </refsect2>
 929
 930   </refsect1>
 931
 932
 933
 934 <refsect1><title>ClamAV Daemon</title>
 935 <para>
 936 CTDB has support to manage the popular anti-virus daemon ClamAV.
 937 This support is implemented through the
 938 eventscript : /etc/ctdb/events.d/31.clamd.
 939 </para>
 940
 941 <refsect2><title>Configuration</title>
 942 <para>
 943 Start by configuring CLAMAV normally and test that it works. Once this is
 944 done, copy the configuration files over to all the nodes so that all nodes
 945 share identical CLAMAV configurations.
 946 Once this is done you can proceed with the intructions below to activate
 947 CTDB support for CLAMAV.
 948 </para>
 949
 950 <para>
 951 First, to activate CLAMAV support in CTDB, edit /etc/sysconfig/ctdb and add the two lines :
 952 </para>
 953 <screen format="linespecific">
 954 CTDB_MANAGES_CLAMD=yes
 955 CTDB_CLAMD_SOCKET="/path/to/clamd.socket"
 956 </screen>
 957
 958 <para>
 959 Second, activate the eventscript by making it executable:
 960 </para>
 961 <screen format="linespecific">
 962 chmod +x /etc/ctdb/events.d/31.clamd
 963 </screen>
 964
 965 <para>
 966 Third, CTDB will now be starting and stopping this service accordingly,
 967 so make sure that the system is not configured to start/stop this service
 968 automatically.
 969 On RedHat systems you can disable the system starting/stopping CLAMAV automatically by running :
 970 <screen format="linespecific">
 971 chkconfig clamd off
 972 </screen>
 973 </para>
 974
 975
 976 <para>
 977 Once you have restarted CTDBD, use
 978 <screen format="linespecific">
 979 ctdb scriptstatus
 980 </screen>
 981 and verify that the 31.clamd eventscript is listed and that it was executed successfully.
 982 </para>
 983
 984 </refsect2>
 985 </refsect1>
 986
 987
 988
 989
 990   <refsect1><title>SEE ALSO</title>
 991     <para>
 992       ctdb(1), onnode(1)
 993       <ulink url="http://ctdb.samba.org/"/>
 994     </para>
 995   </refsect1>
 996
 997   <refsect1><title>COPYRIGHT/LICENSE</title>
 998 <literallayout>
 999 Copyright (C) Andrew Tridgell 2007
1000 Copyright (C) Ronnie sahlberg 2007
1001
1002 This program is free software; you can redistribute it and/or modify
1003 it under the terms of the GNU General Public License as published by
1004 the Free Software Foundation; either version 3 of the License, or (at
1005 your option) any later version.
1006
1007 This program is distributed in the hope that it will be useful, but
1008 WITHOUT ANY WARRANTY; without even the implied warranty of
1009 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1010 General Public License for more details.
1011
1012 You should have received a copy of the GNU General Public License
1013 along with this program; if not, see http://www.gnu.org/licenses/.
1014 </literallayout>
1015   </refsect1>
1016 </refentry>