1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdbd</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdbd.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdbd — The CTDB cluster daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdbd</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdbd</code> {--reclock=<filename>} {--nlist=<filename>} {--dbdir=<directory>} [-? --help] [--usage] [-i --interactive] [--public-addresses=<filename>] [--public-interface=<interface>] [--event-script=<filename>] [--logfile=<filename>] [--listen=<address>] [--transport=<STRING>] [--socket=<filename>] [-d --debug=<INTEGER>] [--torture]</p></div></div><div class="refsect1" lang="en"><a name="id2481068"></a><h2>DESCRIPTION</h2><p>
2 ctdbd is the main ctdb daemon.
4 ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
6 Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services.
8 ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
10 ctdbd is the main component in clustered Samba that provides a high-awailability load-sharing CIFS server cluster.
11 </p></div><div class="refsect1" lang="en"><a name="id2481100"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-? --help</span></dt><dd><p>
12 Print some help text to the screen.
13 </p></dd><dt><span class="term">--usage</span></dt><dd><p>
14 Print useage information to the screen.
15 </p></dd><dt><span class="term">--reclock=<filename></span></dt><dd><p>
16 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.
17 This file must be stored on shared storage.
18 </p></dd><dt><span class="term">--nlist=<filename></span></dt><dd><p>
19 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.
21 This file is usually /etc/ctdb/nodes .
22 </p></dd><dt><span class="term">--dbdir=<directory></span></dt><dd><p>
23 This is the directory on local storage where ctdbd keeps the local
24 copy of the TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
26 This directory would usually be /var/ctdb .
27 </p></dd><dt><span class="term">-i --interactive</span></dt><dd><p>
28 By default ctdbd will detach itself from the shell and run in
29 the background as a daemon. This option makes ctdbd to start in interactive mode.
30 </p></dd><dt><span class="term">--public_addresses=<filename></span></dt><dd><p>
31 When used with IP takeover this specifies a file containing the public ip addresses to use on the cluster. This file contains one entry for each node in the cluster.
33 This is usually the file /etc/ctdb/public_addresses
34 </p></dd><dt><span class="term">--public-interface=<interface></span></dt><dd><p>
35 When used with IP takeover this option specifies which physical interface should be used to attach the public addresses to.
36 </p></dd><dt><span class="term">--event-script=<filename></span></dt><dd><p>
37 This option is used to specify which events script that ctdbd will
38 use to manage services when the cluster configuration changes.
40 This will normally be /etc/ctdb/events which is part of the ctdb distribution.
41 </p></dd><dt><span class="term">--logfile=<filename></span></dt><dd><p>
42 This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
43 </p></dd><dt><span class="term">--listen=<address></span></dt><dd><p>
44 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.
46 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.
47 </p></dd><dt><span class="term">--transport=<STRING></span></dt><dd><p>
48 This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
50 Suported transports are "tcp" and "infiniband".
51 </p></dd><dt><span class="term">--socket=<filename></span></dt><dd><p>
52 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.
54 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.
55 </p></dd><dt><span class="term">-d --debug=<DEBUGLEVEL></span></dt><dd><p>
56 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.
57 </p></dd><dt><span class="term">--torture</span></dt><dd><p>
58 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.
60 You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
61 </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2528438"></a><h2>Private vs Public addresses</h2><p>
62 When used for ip takeover in a HA environment, each node in a ctdb
63 cluster has two ip addresses assigned to it. One private and one public.
64 </p><div class="refsect2" lang="en"><a name="id2528448"></a><h3>Private address</h3><p>
65 This is the physical ip address of the node which is configured in
66 linux and attached to a physical interface. This address uniquely
67 identifies a physical node in the cluster and is the ip addresses
68 that ctdbd will use to communicate with the ctdbd daemons on the
69 other nodes in the cluster.
71 The private addresses are configured in /etc/ctdb/nodes
72 (unless the --nlist option is used) and contain one line for each
73 node in the cluster. Each line contains the private ip address for one
76 Each node is assigned an internal node number which corresponds to
77 which line in the nodes file that has the local private address
80 Since the private addresses are only available to the network when the
81 corresponding node is up and running you should not use these addresses
82 for clients to connect to services provided by the cluster. Instead
83 client applications should only attach to the public addresses since
84 these are guaranteed to always be available.
86 Example /etc/ctdb/nodes for a four node cluster:
92 </pre></div><div class="refsect2" lang="en"><a name="id2528495"></a><h3>Public address</h3><p>
93 A public address on the other hand is not attached to an interface.
94 This address is managed by ctdbd itself and is attached/detached to
95 a physical node at runtime. You should NOT have this address configured
96 to an interface in linux. Let ctdbd manage these addresses.
98 The ctdb cluster will assign/reassign these public addresses across the
99 available nodes in the cluster. When one node fails, its public address
100 will be migrated to and taken over by a different node in the cluster
101 to ensure that all public addresses are always available to clients.
103 These addresses are not physically attached to a specific node.
104 The 'ctdb ip' command can be used to view the current assignment of
105 public addresses and which physical node is currently serving it.
107 By default, each node will when operational always serve its primary
108 public address which is the corresponding line for that node number
109 in the public addresses file. I.e. as long as node X is available and
110 fully oprational it will always be the node that serves the
111 corresponding public address.
113 The list of public addresses also contain the netmask for that address.
114 the reason for this is because ctdbd needs to know which mask to use
115 when it adds/removes the address from a physical node. This netmask
116 is also used by ctdbd when making decisions on which node should take
117 over a public ip address for a failed node.
118 A node will only be allowed to take over a public address from a
119 different node IFF that public address resides in the same subnet
120 as the primary public address for that node.
122 Example /etc/ctdb/public_addresses for a four node cluster:
129 In this example, if node 3 fails, its public address can be taken over
130 by node 2 since node 2 is on the same subnet as 3 but not by node 0 or
131 node 1 since node 0 and 1 are both on a different subnet from node 3.
132 </p></div></div><div class="refsect1" lang="en"><a name="id2528564"></a><h2>Node status</h2><p>
133 The current status of each node in the cluster can be viewed by the
134 'ctdb status' command.
136 There are five possible for a node.
138 OK - This node is fully functional.
140 DISCONNECTED - This node could not be connected through the network
141 and is currently not particpating in the cluster. If there is a
142 public IP address associated with this node it should have been taken
143 over by a different node. No services are running on this node.
145 DISABLED - This node has been administratively disabled. This node is
146 still functional and participates in the CTDB cluster but its IP
147 addresses have been taken over by a different node and no services are
148 currently being hosted.
150 UNHEALTHY - A service provided by this node is malfunctioning and should
151 be investigated. The CTDB daemon itself is operational and participates
152 in the cluster. Its public IP address has been taken over by a different
153 node and no services are currently being hosted. All unhealthy nodes
154 should be investigated and require an administrative action to rectify.
156 BANNED - This node failed too many recovery attempts and has been banned
157 from participating in the cluster for a period of RecoveryBanPeriod
158 seconds. Any public IP address has been taken over by other nodes. This
159 node does not provide any services. All banned nodes should be
160 investigated and require an administrative action to rectify. This node
161 does not perticipate in the CTDB cluster but can still be communicated
162 with. I.e. ctdb commands can be sent to it.
163 </p></div><div class="refsect1" lang="en"><a name="id2528621"></a><h2>SEE ALSO</h2><p>
165 <a href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
166 </p></div><div class="refsect1" lang="en"><a name="id2528634"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
167 Copyright (C) Andrew Tridgell 2007<br>
168 Copyright (C) Ronnie sahlberg 2007<br>
170 This program is free software; you can redistribute it and/or modify<br>
171 it under the terms of the GNU General Public License as published by<br>
172 the Free Software Foundation; either version 3 of the License, or (at<br>
173 your option) any later version.<br>
175 This program is distributed in the hope that it will be useful, but<br>
176 WITHOUT ANY WARRANTY; without even the implied warranty of<br>
177 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU<br>
178 General Public License for more details.<br>
180 You should have received a copy of the GNU General Public License<br>
181 along with this program; if not, see http://www.gnu.org/licenses/.<br>
182 </p></div></div></div></body></html>