make 'ctdb ip' provide machinereadble output using '-Y'
[metze/ctdb/wip.git] / doc / ctdbd.1
1 .\"     Title: ctdbd
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
4 .\"      Date: 03/04/2008
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "CTDBD" "1" "03/04/2008" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 ctdbd \- The CTDB cluster daemon
15 .SH "SYNOPSIS"
16 .HP 6
17 \fBctdbd\fR
18 .HP 6
19 \fBctdbd\fR [\-?\ \-\-help] [\-d\ \-\-debug=<INTEGER>] {\-\-dbdir=<directory>} {\-\-dbdir\-persistent=<directory>} [\-\-event\-script\-dir=<directory>] [\-i\ \-\-interactive] [\-\-listen=<address>] [\-\-logfile=<filename>] {\-\-nlist=<filename>} [\-\-nosetsched] [\-\-public\-addresses=<filename>] [\-\-public\-interface=<interface>] {\-\-reclock=<filename>} [\-\-single\-public\-ip=<address>] [\-\-socket=<filename>] [\-\-start\-as\-disabled] [\-\-syslog] [\-\-torture] [\-\-transport=<STRING>] [\-\-usage]
20 .SH "DESCRIPTION"
21 .PP
22 ctdbd is the main ctdb daemon.
23 .PP
24 ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
25 .PP
26 Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services.
27 .PP
28 ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
29 .PP
30 ctdbd is the main component in clustered Samba that provides a high\-awailability load\-sharing CIFS server cluster.
31 .SH "OPTIONS"
32 .PP
33 \-? \-\-help
34 .RS 3n
35 Print some help text to the screen.
36 .RE
37 .PP
38 \-d \-\-debug=<DEBUGLEVEL>
39 .RS 3n
40 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.
41 .RE
42 .PP
43 \-\-dbdir=<directory>
44 .RS 3n
45 This is the directory on local storage where ctdbd keeps the local copy of the TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
46 .sp
47 This directory would usually be /var/ctdb .
48 .RE
49 .PP
50 \-\-dbdir\-persistent=<directory>
51 .RS 3n
52 This is the directory on local storage where ctdbd keeps the local copy of the persistent TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
53 .sp
54 This directory would usually be /etc/ctdb/persistent .
55 .RE
56 .PP
57 \-\-event\-script\-dir=<directory>
58 .RS 3n
59 This option is used to specify the directory where the CTDB event scripts are stored.
60 .sp
61 This will normally be /etc/ctdb/events.d which is part of the ctdb distribution.
62 .RE
63 .PP
64 \-i \-\-interactive
65 .RS 3n
66 By default ctdbd will detach itself from the shell and run in the background as a daemon. This option makes ctdbd to start in interactive mode.
67 .RE
68 .PP
69 \-\-listen=<address>
70 .RS 3n
71 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.
72 .sp
73 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.
74 .RE
75 .PP
76 \-\-logfile=<filename>
77 .RS 3n
78 This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
79 .RE
80 .PP
81 \-\-nlist=<filename>
82 .RS 3n
83 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.
84 .sp
85 This file is usually /etc/ctdb/nodes .
86 .RE
87 .PP
88 \-\-nosetsched
89 .RS 3n
90 This is a ctdbd debugging option. this option is only used when debugging ctdbd.
91 .sp
92 Normally ctdb will change its scheduler to run as a real\-time process. This is the default mode for a normal ctdbd operation to gurarantee that ctdbd always gets the cpu cycles that it needs.
93 .sp
94 This option is used to tell ctdbd to NOT run as a real\-time process and instead run ctdbd as a normal userspace process. This is useful for debugging and when you want to run ctdbd under valgrind or gdb. (You dont want to attach valgrind or gdb to a real\-time process.)
95 .RE
96 .PP
97 \-\-public_addresses=<filename>
98 .RS 3n
99 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.
100 .sp
101 This is usually the file /etc/ctdb/public_addresses
102 .RE
103 .PP
104 \-\-public\-interface=<interface>
105 .RS 3n
106 This option tells ctdb which interface to attach public\-addresses to and also where to attach the single\-public\-ip when used.
107 .sp
108 This is only required when using public ip addresses and only when you dont specify the interface explicitely on in /etc/ctdb/public_addresses or when you are using \-\-single\-public\-ip.
109 .sp
110 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.
111 .RE
112 .PP
113 \-\-reclock=<filename>
114 .RS 3n
115 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. This file must be stored on shared storage.
116 .RE
117 .PP
118 \-\-single\-public\-ip=<address>
119 .RS 3n
120 This option is used to activate the "ipmux" or the "lvs" functionality of ctdb where the cluster provides a single public ip address for the entire cluster. When using this option you must also use the \-\-public\-interface option.
121 .sp
122 In this mode, all nodes of the cluster will expose a single ip address from all nodes with all incoming traffic to the cluster being passed through the current recmaster. This functionality is similar to using a load\-balancing switch.
123 .sp
124 All incoming packets are sent to the recmaster which will multiplex the clients across all available nodes and pass the packets on to a different node in the cluster to manage the connection based on the clients ip address. Outgoing packets however are sent directly from the node that was choosen back to the client. Since all incoming packets are sent through the recmaster this will have a throughput and performance impact when used. This impact in performance primarily affects write\-performance while read\-performance should be mainly unaffected. Only use this feature if your environment is mostly\-read (i.e. most traffic is from the nodes back to the clients) or if it is not important to get maximum write\-performance to the cluster.
125 .sp
126 This feature is completely controlled from the eventscripts and does not require any CTDBD involvement. However, the CTDBD daemon does need to know that the "single public ip" exists so that the CTDBD daemon will allow clients to set up killtcp to work on this ip address.
127 .sp
128 CTDBD only allows clients to use killtcp to kill off (RST) tcp connections to/from an ip address that is either a normal public address or to/from the ip address specified by \-\-single\-public\-ip. No other tcp connections are allowed to be specified with killtcp.
129 .RE
130 .PP
131 \-\-socket=<filename>
132 .RS 3n
133 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.
134 .sp
135 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.
136 .RE
137 .PP
138 \-\-start\-as\-disabled
139 .RS 3n
140 This makes the ctdb daemon to be DISABLED when it starts up.
141 .sp
142 As it is DISABLED it will not get any of the public ip addresses allocated to it, and thus this allow you to start ctdb on a node without causing any ip address to failover from other nodes onto the new node.
143 .sp
144 When used, the administrator must keep track of when nodes start and manually enable them again using the "ctdb enable" command, or else the node will not host any services.
145 .sp
146 A node that is DISABLED will not host any services and will not be reachable/used by any clients.
147 .RE
148 .PP
149 \-\-syslog
150 .RS 3n
151 Send all log messages to syslog instead of to the ctdb logfile.
152 .RE
153 .PP
154 \-\-torture
155 .RS 3n
156 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.
157 .sp
158 You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
159 .RE
160 .PP
161 \-\-transport=<STRING>
162 .RS 3n
163 This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
164 .sp
165 Currently only "tcp" is supported but "infiniband" might be implemented in the future.
166 .RE
167 .PP
168 \-\-usage
169 .RS 3n
170 Print useage information to the screen.
171 .RE
172 .SH "PRIVATE VS PUBLIC ADDRESSES"
173 .PP
174 When used for ip takeover in a HA environment, each node in a ctdb cluster has multiple ip addresses assigned to it. One private and one or more public.
175 .SS "Private address"
176 .PP
177 This is the physical ip address of the node which is configured in linux and attached to a physical interface. This address uniquely identifies a physical node in the cluster and is the ip addresses that ctdbd will use to communicate with the ctdbd daemons on the other nodes in the cluster.
178 .PP
179 The private addresses are configured in /etc/ctdb/nodes (unless the \-\-nlist option is used) and contain one line for each node in the cluster. Each line contains the private ip address for one node in the cluster. This file must be the same on all nodes in the cluster.
180 .PP
181 Since the private addresses are only available to the network when the corresponding node is up and running you should not use these addresses for clients to connect to services provided by the cluster. Instead client applications should only attach to the public addresses since these are guaranteed to always be available.
182 .PP
183 When using ip takeover, it is strongly recommended that the private addresses are configured on a private network physically separated from the rest of the network and that this private network is dedicated to CTDB traffic.
184
185       Example /etc/ctdb/nodes for a four node cluster:
186       
187 .sp
188 .RS 3n
189 .nf
190         10.1.1.1
191         10.1.1.2
192         10.1.1.3
193         10.1.1.4
194       
195 .fi
196 .RE
197 .SS "Public address"
198 .PP
199 A public address on the other hand is not attached to an interface. This address is managed by ctdbd itself and is attached/detached to a physical node at runtime.
200 .PP
201 The ctdb cluster will assign/reassign these public addresses across the available healthy nodes in the cluster. When one node fails, its public address will be migrated to and taken over by a different node in the cluster to ensure that all public addresses are always available to clients as long as there are still nodes available capable of hosting this address.
202 .PP
203 These addresses are not physically attached to a specific node. The 'ctdb ip' command can be used to view the current assignment of public addresses and which physical node is currently serving it.
204 .PP
205 On each node this file contains a list of the public addresses that this node is capable of hosting. The list also contain the netmask and the interface where this address should be attached for the case where you may want to serve data out through multiple different interfaces.
206
207       Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
208       
209 .sp
210 .RS 3n
211 .nf
212         11.1.1.1/24 eth0
213         11.1.1.2/24 eth0
214         11.1.2.1/24 eth1
215         11.1.2.2/24 eth1
216       
217 .fi
218 .RE
219 .PP
220 In most cases this file would be the same on all nodes in a cluster but there are exceptions when one may want to use different files on different nodes.
221
222         Example: 4 nodes partitioned into two subgroups :
223         
224 .sp
225 .RS 3n
226 .nf
227         Node 0:/etc/ctdb/public_addresses
228                 10.1.1.1/24 eth0
229                 10.1.1.2/24 eth0
230
231         Node 1:/etc/ctdb/public_addresses
232                 10.1.1.1/24 eth0
233                 10.1.1.2/24 eth0
234
235         Node 2:/etc/ctdb/public_addresses
236                 10.2.1.1/24 eth0
237                 10.2.1.2/24 eth0
238
239         Node 3:/etc/ctdb/public_addresses
240                 10.2.1.1/24 eth0
241                 10.2.1.2/24 eth0
242         
243 .fi
244 .RE
245 .PP
246 In this example nodes 0 and 1 host two public addresses on the 10.1.1.x network while nodes 2 and 3 host two public addresses for the 10.2.1.x network.
247 .PP
248 Ip address 10.1.1.1 can be hosted by either of nodes 0 or 1 and will be available to clients as long as at least one of these two nodes are available. If both nodes 0 and node 1 become unavailable 10.1.1.1 also becomes unavailable. 10.1.1.1 can not be failed over to node 2 or node 3 since these nodes do not have this ip address listed in their public addresses file.
249 .SH "NODE STATUS"
250 .PP
251 The current status of each node in the cluster can be viewed by the 'ctdb status' command.
252 .PP
253 There are five possible for a node.
254 .PP
255 OK \- This node is fully functional.
256 .PP
257 DISCONNECTED \- This node could not be connected through the network and is currently not particpating in the cluster. If there is a public IP address associated with this node it should have been taken over by a different node. No services are running on this node.
258 .PP
259 DISABLED \- This node has been administratively disabled. This node is still functional and participates in the CTDB cluster but its IP addresses have been taken over by a different node and no services are currently being hosted.
260 .PP
261 UNHEALTHY \- A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currently being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify.
262 .PP
263 BANNED \- This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be investigated and require an administrative action to rectify. This node does not perticipate in the CTDB cluster but can still be communicated with. I.e. ctdb commands can be sent to it.
264 .SH "PUBLIC TUNABLES"
265 .PP
266 These are the public tuneables that can be used to control how ctdb behaves.
267 .SS "KeepaliveInterval"
268 .PP
269 Default: 1
270 .PP
271 How often should the nodes send keepalives to eachother.
272 .SS "KeepaliveLimit"
273 .PP
274 Default: 5
275 .PP
276 After how many keepalive intervals without any traffic should a node wait until marking the peer as DISCONNECTED.
277 .SS "MonitorInterval"
278 .PP
279 Default: 15
280 .PP
281 How often should ctdb run the event scripts to check for a nodes health.
282 .SS "TickleUpdateInterval"
283 .PP
284 Default: 20
285 .PP
286 How often will ctdb record and store the "tickle" information used to kickstart stalled tcp connections after a recovery.
287 .SS "EventScriptTimeout"
288 .PP
289 Default: 20
290 .PP
291 How long should ctdb let an event script run before aborting it and marking the node unhealthy.
292 .SS "RecoveryBanPeriod"
293 .PP
294 Default: 300
295 .PP
296 If a node becomes banned causing repetitive recovery failures. The node will eventually become banned from the cluster. This controls how long the culprit node will be banned from the cluster before it is allowed to try to join the cluster again. Dont set to small. A node gets banned for a reason and it is usually due to real problems with the node.
297 .SS "DatabaseHashSize"
298 .PP
299 Default: 100000
300 .PP
301 Size of the hash chains for the local store of the tdbs that ctdb manages.
302 .SS "RerecoveryTimeout"
303 .PP
304 Default: 10
305 .PP
306 Once a recovery has completed, no additional recoveries are permitted until this timeout has expired.
307 .SS "EnableBans"
308 .PP
309 Default: 1
310 .PP
311 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.
312 .SS "DeterministicIPs"
313 .PP
314 Default: 1
315 .PP
316 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.
317 .PP
318 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.
319 .SS "DisableWhenUnhealthy"
320 .PP
321 Default: 0
322 .PP
323 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'.
324 .PP
325 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.
326 .SS "NoIPFailback"
327 .PP
328 Default: 0
329 .PP
330 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.
331 .PP
332 Use with caution! Normally when a node becomes available to the cluster 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.
333 .PP
334 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.
335 .SH "SEE ALSO"
336 .PP
337 ctdb(1), onnode(1)
338 \fI\%http://ctdb.samba.org/\fR
339 .SH "COPYRIGHT/LICENSE"
340 .sp
341 .RS 3n
342 .nf
343 Copyright (C) Andrew Tridgell 2007
344 Copyright (C) Ronnie sahlberg 2007
345
346 This program is free software; you can redistribute it and/or modify
347 it under the terms of the GNU General Public License as published by
348 the Free Software Foundation; either version 3 of the License, or (at
349 your option) any later version.
350
351 This program is distributed in the hope that it will be useful, but
352 WITHOUT ANY WARRANTY; without even the implied warranty of
353 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
354 General Public License for more details.
355
356 You should have received a copy of the GNU General Public License
357 along with this program; if not, see http://www.gnu.org/licenses/.
358 .fi
359 .RE