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="req">--reclock=&lt;filename&gt;</arg>
  24                 <arg choice="req">--nlist=&lt;filename&gt;</arg>
  25                 <arg choice="req">--dbdir=&lt;directory&gt;</arg>
  26                 <arg choice="opt">-? --help</arg>
  27                 <arg choice="opt">--usage</arg>
  28                 <arg choice="opt">-i --interactive</arg>
  29                 <arg choice="opt">--public-addresses=&lt;filename&gt;</arg>
  30                 <arg choice="opt">--event-script-dir=&lt;directory&gt;</arg>
  31                 <arg choice="opt">--logfile=&lt;filename&gt;</arg>
  32                 <arg choice="opt">--listen=&lt;address&gt;</arg>
  33                 <arg choice="opt">--transport=&lt;STRING&gt;</arg>
  34                 <arg choice="opt">--socket=&lt;filename&gt;</arg>
  35                 <arg choice="opt">-d --debug=&lt;INTEGER&gt;</arg>
  36                 <arg choice="opt">--torture</arg>
  37         </cmdsynopsis>
  38
  39 </refsynopsisdiv>
  40
  41   <refsect1><title>DESCRIPTION</title>
  42     <para>
  43       ctdbd is the main ctdb daemon.
  44     </para>
  45     <para>
  46       ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
  47     </para>
  48     <para>
  49       Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services.
  50     </para>
  51     <para>
  52       ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
  53     </para>
  54     <para>
  55       ctdbd is the main component in clustered Samba that provides a high-awailability load-sharing CIFS server cluster.
  56     </para>
  57   </refsect1>
  58
  59
  60   <refsect1>
  61     <title>OPTIONS</title>
  62
  63     <variablelist>
  64       <varlistentry><term>-? --help</term>
  65         <listitem>
  66           <para>
  67             Print some help text to the screen.
  68           </para>
  69         </listitem>
  70       </varlistentry>
  71
  72       <varlistentry><term>--usage</term>
  73         <listitem>
  74           <para>
  75             Print useage information to the screen.
  76           </para>
  77         </listitem>
  78       </varlistentry>
  79
  80       <varlistentry><term>--reclock=&lt;filename&gt;</term>
  81         <listitem>
  82           <para>
  83             This is the name of the lock file stored of the shared cluster filesystem that ctdbd uses to arbitrate which node has the role of recovery-master.
  84             This file must be stored on shared storage.
  85           </para>
  86         </listitem>
  87       </varlistentry>
  88
  89       <varlistentry><term>--nlist=&lt;filename&gt;</term>
  90         <listitem>
  91           <para>
  92             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.
  93           </para>
  94           <para>
  95             This file is usually /etc/ctdb/nodes .
  96           </para>
  97         </listitem>
  98       </varlistentry>
  99
 100       <varlistentry><term>--dbdir=&lt;directory&gt;</term>
 101         <listitem>
 102           <para>
 103             This is the directory on local storage where ctdbd keeps the local
 104             copy of the TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
 105           </para>
 106           <para>
 107             This directory would usually be /var/ctdb .
 108           </para>
 109         </listitem>
 110       </varlistentry>
 111
 112       <varlistentry><term>-i --interactive</term>
 113         <listitem>
 114           <para>
 115             By default ctdbd will detach itself from the shell and run in
 116             the background as a daemon. This option makes ctdbd to start in interactive mode.
 117           </para>
 118         </listitem>
 119       </varlistentry>
 120
 121       <varlistentry><term>--public_addresses=&lt;filename&gt;</term>
 122         <listitem>
 123           <para>
 124             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.
 125           </para>
 126           <para>
 127             This is usually the file /etc/ctdb/public_addresses
 128           </para>
 129         </listitem>
 130       </varlistentry>
 131
 132       <varlistentry><term>--event-script-dir=&lt;directory&gt;</term>
 133         <listitem>
 134           <para>
 135             This option is used to specify the directory where the CTDB event
 136             scripts are stored.
 137           </para>
 138           <para>
 139             This will normally be /etc/ctdb/events.d which is part of the ctdb distribution.
 140           </para>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry><term>--logfile=&lt;filename&gt;</term>
 145         <listitem>
 146           <para>
 147             This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
 148           </para>
 149         </listitem>
 150       </varlistentry>
 151
 152       <varlistentry><term>--listen=&lt;address&gt;</term>
 153         <listitem>
 154           <para>
 155             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.
 156           </para>
 157           <para>
 158             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.
 159           </para>
 160         </listitem>
 161       </varlistentry>
 162
 163       <varlistentry><term>--transport=&lt;STRING&gt;</term>
 164         <listitem>
 165           <para>
 166             This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
 167           </para>
 168           <para>
 169             Suported transports are "tcp" and "infiniband".
 170           </para>
 171         </listitem>
 172       </varlistentry>
 173
 174       <varlistentry><term>--socket=&lt;filename&gt;</term>
 175         <listitem>
 176           <para>
 177             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.
 178           </para>
 179           <para>
 180             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.
 181           </para>
 182         </listitem>
 183       </varlistentry>
 184
 185       <varlistentry><term>-d --debug=&lt;DEBUGLEVEL&gt;</term>
 186         <listitem>
 187           <para>
 188             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.
 189           </para>
 190         </listitem>
 191       </varlistentry>
 192
 193       <varlistentry><term>--torture</term>
 194         <listitem>
 195           <para>
 196             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.
 197           </para>
 198           <para>
 199             You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
 200           </para>
 201         </listitem>
 202       </varlistentry>
 203     </variablelist>
 204   </refsect1>
 205
 206
 207   <refsect1><title>Private vs Public addresses</title>
 208     <para>
 209       When used for ip takeover in a HA environment, each node in a ctdb
 210       cluster has multiple ip addresses assigned to it. One private and one or more public.
 211     </para>
 212
 213     <refsect2><title>Private address</title>
 214       <para>
 215         This is the physical ip address of the node which is configured in
 216         linux and attached to a physical interface. This address uniquely
 217         identifies a physical node in the cluster and is the ip addresses
 218         that ctdbd will use to communicate with the ctdbd daemons on the
 219         other nodes in the cluster.
 220       </para>
 221       <para>
 222         The private addresses are configured in /etc/ctdb/nodes
 223         (unless the --nlist option is used) and contain one line for each
 224         node in the cluster. Each line contains the private ip address for one
 225         node in the cluster. This file must be the same on all nodes in the
 226         cluster.
 227       </para>
 228       <para>
 229         Since the private addresses are only available to the network when the
 230         corresponding node is up and running you should not use these addresses
 231         for clients to connect to services provided by the cluster. Instead
 232         client applications should only attach to the public addresses since
 233         these are guaranteed to always be available.
 234       </para>
 235       <para>
 236         When using ip takeover, it is strongly recommended that the private
 237         addresses are configured on a private network physically separated
 238         from the rest of the network and that this private network is dedicated
 239         to CTDB traffic.
 240       </para>
 241       Example /etc/ctdb/nodes for a four node cluster:
 242       <screen format="linespecific">
 243         10.1.1.1
 244         10.1.1.2
 245         10.1.1.3
 246         10.1.1.4
 247       </screen>
 248     </refsect2>
 249     <refsect2><title>Public address</title>
 250       <para>
 251         A public address on the other hand is not attached to an interface.
 252         This address is managed by ctdbd itself and is attached/detached to
 253         a physical node at runtime.
 254       </para>
 255       <para>
 256         The ctdb cluster will assign/reassign these public addresses across the
 257         available healthy nodes in the cluster. When one node fails, its public address
 258         will be migrated to and taken over by a different node in the cluster
 259         to ensure that all public addresses are always available to clients as
 260         long as there are still nodes available capable of hosting this address.
 261       </para>
 262       <para>
 263         These addresses are not physically attached to a specific node.
 264         The 'ctdb ip' command can be used to view the current assignment of
 265         public addresses and which physical node is currently serving it.
 266       </para>
 267       <para>
 268         On each node this file contains a list of the public addresses that
 269         this node is capable of hosting.
 270         The list also contain the netmask and the
 271         interface where this address should be attached for the case where you
 272         may want to serve data out through multiple different interfaces.
 273       </para>
 274       Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
 275       <screen format="linespecific">
 276         11.1.1.1/24 eth0
 277         11.1.1.2/24 eth0
 278         11.1.2.1/24 eth1
 279         11.1.2.2/24 eth1
 280       </screen>
 281
 282         <para>
 283         In most cases this file would be the same on all nodes in a cluster but
 284         there are exceptions when one may want to use different files
 285         on different nodes.
 286         </para>
 287         Example: 4 nodes partitioned into two subgroups :
 288         <screen format="linespecific">
 289         Node 0:/etc/ctdb/public_addresses
 290                 10.1.1.1/24 eth0
 291                 10.1.1.2/24 eth0
 292
 293         Node 1:/etc/ctdb/public_addresses
 294                 10.1.1.1/24 eth0
 295                 10.1.1.2/24 eth0
 296
 297         Node 2:/etc/ctdb/public_addresses
 298                 10.2.1.1/24 eth0
 299                 10.2.1.2/24 eth0
 300
 301         Node 3:/etc/ctdb/public_addresses
 302                 10.2.1.1/24 eth0
 303                 10.2.1.2/24 eth0
 304         </screen>
 305         <para>
 306         In this example nodes 0 and 1 host two public addresses on the
 307         10.1.1.x network  while nodes 2 and 3 host two public addresses for the
 308         10.2.1.x network.
 309         </para>
 310         <para>
 311         Ip address 10.1.1.1 can be hosted by either of nodes 0 or 1 and will be
 312         available to clients as long as at least one of these two nodes are
 313         available.
 314         If both nodes 0 and node 1 become unavailable 10.1.1.1 also becomes
 315         unavailable. 10.1.1.1 can not be failed over to node 2 or node 3 since
 316         these nodes do not have this ip address listed in their public
 317         addresses file.
 318         </para>
 319     </refsect2>
 320   </refsect1>
 321
 322
 323   <refsect1><title>Node status</title>
 324     <para>
 325       The current status of each node in the cluster can be viewed by the
 326       'ctdb status' command.
 327     </para>
 328     <para>
 329       There are five possible for a node.
 330     </para>
 331
 332     <para>
 333       OK - This node is fully functional.
 334     </para>
 335
 336     <para>
 337       DISCONNECTED - This node could not be connected through the network
 338       and is currently not particpating in the cluster. If there is a
 339       public IP address associated with this node it should have been taken
 340       over by a different node. No services are running on this node.
 341     </para>
 342
 343     <para>
 344       DISABLED - This node has been administratively disabled. This node is
 345       still functional and participates in the CTDB cluster but its IP
 346       addresses have been taken over by a different node and no services are
 347       currently being hosted.
 348     </para>
 349
 350     <para>
 351       UNHEALTHY - A service provided by this node is malfunctioning and should
 352       be investigated. The CTDB daemon itself is operational and participates
 353       in the cluster. Its public IP address has been taken over by a different
 354       node and no services are currently being hosted. All unhealthy nodes
 355       should be investigated and require an administrative action to rectify.
 356     </para>
 357
 358     <para>
 359       BANNED - This node failed too many recovery attempts and has been banned
 360       from participating in the cluster for a period of RecoveryBanPeriod
 361       seconds. Any public IP address has been taken over by other nodes. This
 362       node does not provide any services. All banned nodes should be
 363       investigated and require an administrative action to rectify. This node
 364       does not perticipate in the CTDB cluster but can still be communicated
 365       with. I.e. ctdb commands can be sent to it.
 366     </para>
 367   </refsect1>
 368
 369
 370   <refsect1><title>SEE ALSO</title>
 371     <para>
 372       ctdb(1), onnode(1)
 373       <ulink url="http://ctdb.samba.org/"/>
 374     </para>
 375   </refsect1>
 376   <refsect1><title>COPYRIGHT/LICENSE</title>
 377 <literallayout>
 378 Copyright (C) Andrew Tridgell 2007
 379 Copyright (C) Ronnie sahlberg 2007
 380
 381 This program is free software; you can redistribute it and/or modify
 382 it under the terms of the GNU General Public License as published by
 383 the Free Software Foundation; either version 3 of the License, or (at
 384 your option) any later version.
 385
 386 This program is distributed in the hope that it will be useful, but
 387 WITHOUT ANY WARRANTY; without even the implied warranty of
 388 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 389 General Public License for more details.
 390
 391 You should have received a copy of the GNU General Public License
 392 along with this program; if not, see http://www.gnu.org/licenses/.
 393 </literallayout>
 394   </refsect1>
 395 </refentry>