Merge commit 'ronnie/master'
[metze/ctdb/wip.git] / doc / ctdbd.1
1 .\"     Title: ctdbd
2 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4 .\"      Date: 10/14/2008
5 .\"    Manual: [FIXME: manual]
6 .\"    Source: [FIXME: source]
7 .\"  Language: English
8 .\"
9 .TH "CTDBD" "1" "10/14/2008" "[FIXME: source]" "[FIXME: manual]"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16 .de toupper
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18 \\$*
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20 ..
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 .de SH-xref
25 .ie n \{\
26 .\}
27 .toupper \\$*
28 .el \{\
29 \\$*
30 .\}
31 ..
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 .de1 SH
36 .\" put an extra blank line of space above the head in non-TTY output
37 .if t \{\
38 .sp 1
39 .\}
40 .sp \\n[PD]u
41 .nr an-level 1
42 .set-an-margin
43 .nr an-prevailing-indent \\n[IN]
44 .fi
45 .in \\n[an-margin]u
46 .ti 0
47 .HTML-TAG ".NH \\n[an-level]"
48 .it 1 an-trap
49 .nr an-no-space-flag 1
50 .nr an-break-flag 1
51 .\" make the size of the head bigger
52 .ps +3
53 .ft B
54 .ne (2v + 1u)
55 .ie n \{\
56 .\" if n (TTY output), use uppercase
57 .toupper \\$*
58 .\}
59 .el \{\
60 .nr an-break-flag 0
61 .\" if not n (not TTY), use normal case (not uppercase)
62 \\$1
63 .in \\n[an-margin]u
64 .ti 0
65 .\" if not n (not TTY), put a border/line under subheading
66 .sp -.6
67 \l'\n(.lu'
68 .\}
69 ..
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 .de1 SS
74 .sp \\n[PD]u
75 .nr an-level 1
76 .set-an-margin
77 .nr an-prevailing-indent \\n[IN]
78 .fi
79 .in \\n[IN]u
80 .ti \\n[SN]u
81 .it 1 an-trap
82 .nr an-no-space-flag 1
83 .nr an-break-flag 1
84 .ps \\n[PS-SS]u
85 .\" make the size of the head bigger
86 .ps +2
87 .ft B
88 .ne (2v + 1u)
89 .if \\n[.$] \&\\$*
90 ..
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 .de BB
95 .if t \{\
96 .sp -.5
97 .br
98 .in +2n
99 .ll -2n
100 .gcolor red
101 .di BX
102 .\}
103 ..
104 .de EB
105 .if t \{\
106 .if "\\$2"adjust-for-leading-newline" \{\
107 .sp -1
108 .\}
109 .br
110 .di
111 .in
112 .ll
113 .gcolor
114 .nr BW \\n(.lu-\\n(.i
115 .nr BH \\n(dn+.5v
116 .ne \\n(BHu+.5v
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119 .\}
120 .el \{\
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122 .\}
123 .in 0
124 .sp -.5v
125 .nf
126 .BX
127 .in
128 .sp .5v
129 .fi
130 .\}
131 ..
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135 .de BM
136 .if t \{\
137 .br
138 .ll -2n
139 .gcolor red
140 .di BX
141 .\}
142 ..
143 .de EM
144 .if t \{\
145 .br
146 .di
147 .ll
148 .gcolor
149 .nr BH \\n(dn
150 .ne \\n(BHu
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152 .in 0
153 .nf
154 .BX
155 .in
156 .fi
157 .\}
158 ..
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
163 .nh
164 .\" disable justification (adjust text to left margin only)
165 .ad l
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
169 .SH "Name"
170 ctdbd \- The CTDB cluster daemon
171 .SH "Synopsis"
172 .fam C
173 .HP \w'\fBctdbd\fR\ 'u
174 \fBctdbd\fR
175 .fam
176 .fam C
177 .HP \w'\fBctdbd\fR\ 'u
178 \fBctdbd\fR [\-?\ \-\-help] [\-d\ \-\-debug=<INTEGER>] {\-\-dbdir=<directory>} {\-\-dbdir\-persistent=<directory>} [\-\-event\-script\-dir=<directory>] [\-i\ \-\-interactive] [\-\-listen=<address>] [\-\-logfile=<filename>] [\-\-lvs] {\-\-nlist=<filename>} [\-\-no\-lmaster] [\-\-no\-recmaster] [\-\-nosetsched] [\-\-public\-addresses=<filename>] [\-\-public\-interface=<interface>] {\-\-reclock=<filename>} [\-\-single\-public\-ip=<address>] [\-\-socket=<filename>] [\-\-start\-as\-disabled] [\-\-syslog] [\-\-torture] [\-\-transport=<STRING>] [\-\-usage]
179 .fam
180 .SH "DESCRIPTION"
181 .PP
182 ctdbd is the main ctdb daemon\&.
183 .PP
184 ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures\&.
185 .PP
186 Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services\&.
187 .PP
188 ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures\&.
189 .PP
190 ctdbd is the main component in clustered Samba that provides a high\-availability load\-sharing CIFS server cluster\&.
191 .SH "OPTIONS"
192 .PP
193 \-? \-\-help
194 .RS 4
195 Print some help text to the screen\&.
196 .RE
197 .PP
198 \-d \-\-debug=<DEBUGLEVEL>
199 .RS 4
200 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\&.
201 .RE
202 .PP
203 \-\-dbdir=<directory>
204 .RS 4
205 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\&.
206 .sp
207 This directory would usually be /var/ctdb \&.
208 .RE
209 .PP
210 \-\-dbdir\-persistent=<directory>
211 .RS 4
212 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\&.
213 .sp
214 This directory would usually be /etc/ctdb/persistent \&.
215 .RE
216 .PP
217 \-\-event\-script\-dir=<directory>
218 .RS 4
219 This option is used to specify the directory where the CTDB event scripts are stored\&.
220 .sp
221 This will normally be /etc/ctdb/events\&.d which is part of the ctdb distribution\&.
222 .RE
223 .PP
224 \-i \-\-interactive
225 .RS 4
226 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\&.
227 .RE
228 .PP
229 \-\-listen=<address>
230 .RS 4
231 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\&.
232 .sp
233 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\&.
234 .RE
235 .PP
236 \-\-logfile=<filename>
237 .RS 4
238 This is the file where ctdbd will write its log\&. This is usually /var/log/log\&.ctdb \&.
239 .RE
240 .PP
241 \-\-lvs
242 .RS 4
243 This option is used to activate the LVS capability on a CTDB node\&. Please see the LVS section\&.
244 .RE
245 .PP
246 \-\-nlist=<filename>
247 .RS 4
248 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\&.
249 .sp
250 This file is usually /etc/ctdb/nodes \&.
251 .RE
252 .PP
253 \-\-no\-lmaster
254 .RS 4
255 This argument specifies that this node can NOT become an lmaster for records in the database\&. This means that it will never show up in the vnnmap\&. This feature is primarily used for making a cluster span across a WAN link and use CTDB as a WAN\-accelerator\&.
256 .sp
257 Please see the "remote cluster nodes" section for more information\&.
258 .RE
259 .PP
260 \-\-no\-recmaster
261 .RS 4
262 This argument specifies that this node can NOT become a recmaster for the database\&. This feature is primarily used for making a cluster span across a WAN link and use CTDB as a WAN\-accelerator\&.
263 .sp
264 Please see the "remote cluster nodes" section for more information\&.
265 .RE
266 .PP
267 \-\-nosetsched
268 .RS 4
269 This is a ctdbd debugging option\&. this option is only used when debugging ctdbd\&.
270 .sp
271 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\&.
272 .sp
273 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\&.)
274 .RE
275 .PP
276 \-\-public_addresses=<filename>
277 .RS 4
278 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\&.
279 .sp
280 This is usually the file /etc/ctdb/public_addresses
281 .RE
282 .PP
283 \-\-public\-interface=<interface>
284 .RS 4
285 This option tells ctdb which interface to attach public\-addresses to and also where to attach the single\-public\-ip when used\&.
286 .sp
287 This is only required when using public ip addresses and only when you dont specify the interface explicitly in /etc/ctdb/public_addresses or when you are using \-\-single\-public\-ip\&.
288 .sp
289 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\&.
290 .RE
291 .PP
292 \-\-reclock=<filename>
293 .RS 4
294 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\&.
295 .RE
296 .PP
297 \-\-single\-public\-ip=<address>
298 .RS 4
299 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\&.
300 .sp
301 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\&.
302 .sp
303 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\&.
304 .sp
305 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\&.
306 .sp
307 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\&.
308 .sp
309 Please note that ipmux is obsolete\&. Use LVS, not ipmux\&. Please see the LVS section in this manpage for instructions on how to configure and use CTDB with LVS\&.
310 .RE
311 .PP
312 \-\-socket=<filename>
313 .RS 4
314 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\&.
315 .sp
316 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\&.
317 .RE
318 .PP
319 \-\-start\-as\-disabled
320 .RS 4
321 This makes the ctdb daemon to be DISABLED when it starts up\&.
322 .sp
323 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\&.
324 .sp
325 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\&.
326 .sp
327 A node that is DISABLED will not host any services and will not be reachable/used by any clients\&.
328 .RE
329 .PP
330 \-\-syslog
331 .RS 4
332 Send all log messages to syslog instead of to the ctdb logfile\&.
333 .RE
334 .PP
335 \-\-torture
336 .RS 4
337 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\&.
338 .sp
339 You do NOT want to use this option unless you are developing and testing new functionality in ctdbd\&.
340 .RE
341 .PP
342 \-\-transport=<STRING>
343 .RS 4
344 This option specifies which transport to use for ctdbd internode communications\&. The default is "tcp"\&.
345 .sp
346 Currently only "tcp" is supported but "infiniband" might be implemented in the future\&.
347 .RE
348 .PP
349 \-\-usage
350 .RS 4
351 Print useage information to the screen\&.
352 .RE
353 .SH "Private vs Public addresses"
354 .PP
355 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\&.
356 .SS "Private address"
357 .PP
358 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\&.
359 .PP
360 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\&.
361 .PP
362 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\&.
363 .PP
364 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\&.
365
366       Example /etc/ctdb/nodes for a four node cluster:
367       
368 .sp
369 .if n \{\
370 .RS 4
371 .\}
372 .fam C
373 .ps -1
374 .nf
375 .if t \{\
376 .sp -1
377 .\}
378 .BB lightgray adjust-for-leading-newline
379 .sp -1
380
381         10\&.1\&.1\&.1
382         10\&.1\&.1\&.2
383         10\&.1\&.1\&.3
384         10\&.1\&.1\&.4
385       
386 .EB lightgray adjust-for-leading-newline
387 .if t \{\
388 .sp 1
389 .\}
390 .fi
391 .fam
392 .ps +1
393 .if n \{\
394 .RE
395 .\}
396 .SS "Public address"
397 .PP
398 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\&.
399 .PP
400 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\&.
401 .PP
402 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\&.
403 .PP
404 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\&.
405
406       Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
407       
408 .sp
409 .if n \{\
410 .RS 4
411 .\}
412 .fam C
413 .ps -1
414 .nf
415 .if t \{\
416 .sp -1
417 .\}
418 .BB lightgray adjust-for-leading-newline
419 .sp -1
420
421         11\&.1\&.1\&.1/24 eth0
422         11\&.1\&.1\&.2/24 eth0
423         11\&.1\&.2\&.1/24 eth1
424         11\&.1\&.2\&.2/24 eth1
425       
426 .EB lightgray adjust-for-leading-newline
427 .if t \{\
428 .sp 1
429 .\}
430 .fi
431 .fam
432 .ps +1
433 .if n \{\
434 .RE
435 .\}
436 .PP
437 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\&.
438
439         Example: 4 nodes partitioned into two subgroups :
440         
441 .sp
442 .if n \{\
443 .RS 4
444 .\}
445 .fam C
446 .ps -1
447 .nf
448 .if t \{\
449 .sp -1
450 .\}
451 .BB lightgray adjust-for-leading-newline
452 .sp -1
453
454         Node 0:/etc/ctdb/public_addresses
455                 10\&.1\&.1\&.1/24 eth0
456                 10\&.1\&.1\&.2/24 eth0
457
458         Node 1:/etc/ctdb/public_addresses
459                 10\&.1\&.1\&.1/24 eth0
460                 10\&.1\&.1\&.2/24 eth0
461
462         Node 2:/etc/ctdb/public_addresses
463                 10\&.2\&.1\&.1/24 eth0
464                 10\&.2\&.1\&.2/24 eth0
465
466         Node 3:/etc/ctdb/public_addresses
467                 10\&.2\&.1\&.1/24 eth0
468                 10\&.2\&.1\&.2/24 eth0
469         
470 .EB lightgray adjust-for-leading-newline
471 .if t \{\
472 .sp 1
473 .\}
474 .fi
475 .fam
476 .ps +1
477 .if n \{\
478 .RE
479 .\}
480 .PP
481 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\&.
482 .PP
483 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\&.
484 .SH "Node status"
485 .PP
486 The current status of each node in the cluster can be viewed by the \'ctdb status\' command\&.
487 .PP
488 There are five possible states for a node\&.
489 .PP
490 OK \- This node is fully functional\&.
491 .PP
492 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\&.
493 .PP
494 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\&.
495 .PP
496 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\&.
497 .PP
498 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\&.
499 .SH "PUBLIC TUNABLES"
500 .PP
501 These are the public tuneables that can be used to control how ctdb behaves\&.
502 .SS "KeepaliveInterval"
503 .PP
504 Default: 1
505 .PP
506 How often should the nodes send keepalives to eachother\&.
507 .SS "KeepaliveLimit"
508 .PP
509 Default: 5
510 .PP
511 After how many keepalive intervals without any traffic should a node wait until marking the peer as DISCONNECTED\&.
512 .SS "MonitorInterval"
513 .PP
514 Default: 15
515 .PP
516 How often should ctdb run the event scripts to check for a nodes health\&.
517 .SS "TickleUpdateInterval"
518 .PP
519 Default: 20
520 .PP
521 How often will ctdb record and store the "tickle" information used to kickstart stalled tcp connections after a recovery\&.
522 .SS "EventScriptTimeout"
523 .PP
524 Default: 20
525 .PP
526 How long should ctdb let an event script run before aborting it and marking the node unhealthy\&.
527 .SS "RecoveryBanPeriod"
528 .PP
529 Default: 300
530 .PP
531 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\&.
532 .SS "DatabaseHashSize"
533 .PP
534 Default: 100000
535 .PP
536 Size of the hash chains for the local store of the tdbs that ctdb manages\&.
537 .SS "RerecoveryTimeout"
538 .PP
539 Default: 10
540 .PP
541 Once a recovery has completed, no additional recoveries are permitted until this timeout has expired\&.
542 .SS "EnableBans"
543 .PP
544 Default: 1
545 .PP
546 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\&.
547 .SS "DeterministicIPs"
548 .PP
549 Default: 1
550 .PP
551 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\&.
552 .PP
553 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\&.
554 .SS "DisableWhenUnhealthy"
555 .PP
556 Default: 0
557 .PP
558 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\'\&.
559 .PP
560 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\&.
561 .SS "NoIPFailback"
562 .PP
563 Default: 0
564 .PP
565 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\&.
566 .PP
567 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\&.
568 .PP
569 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\&.
570 .SH "LVS"
571 .PP
572 LVS is a mode where CTDB presents one single IP address for the entire cluster\&. This is an alternative to using public IP addresses and round\-robin DNS to loadbalance clients across the cluster\&.
573 .PP
574 This is similar to using a layer\-4 loadbalancing switch but with some restrictions\&.
575 .PP
576 In this mode the cluster select a set of nodes in the cluster and loadbalance 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 all LVS capable nodes regardless of health status\&. LVS will however never loadbalance traffic to nodes that are BANNED, DISABLED or DISCONNECTED\&. The "ctdb lvs" command is used to show which nodes are currently load\-balanced across\&.
577 .PP
578 One of the these nodes are elected as the LVSMASTER\&. This node receives all traffic from clients coming in to the LVS address and multiplexes it across the internal network to one of the nodes that LVS is using\&. When responding to the client, that node will send the data back directly to the client, bypassing the LVSMASTER node\&. The command "ctdb lvsmaster" will show which node is the current LVSMASTER\&.
579 .PP
580 The path used for a client i/o is thus :
581 .sp
582 .if n \{\
583 .RS 4
584 .\}
585 .fam C
586 .ps -1
587 .nf
588 .if t \{\
589 .sp -1
590 .\}
591 .BB lightgray adjust-for-leading-newline
592 .sp -1
593
594         (1) Client sends request packet to LVSMASTER
595         (2) LVSMASTER passes the request on to one node across the internal network\&.
596         (3) Selected node processes the request\&.
597         (4) Node responds back to client\&.
598     
599 .EB lightgray adjust-for-leading-newline
600 .if t \{\
601 .sp 1
602 .\}
603 .fi
604 .fam
605 .ps +1
606 .if n \{\
607 .RE
608 .\}
609 .PP
610 This means that all incoming traffic to the cluster will pass through one physical node, which limits scalability\&. You can send more data to the LVS address that one physical node can multiplex\&. This means that you should not use LVS if your I/O pattern is write\-intensive since you will be limited in the available network bandwidth that node can handle\&. LVS does work wery well for read\-intensive workloads where only smallish READ requests are going through the LVSMASTER bottleneck and the majority of the traffic volume (the data in the read replies) goes straight from the processing node back to the clients\&. For read\-intensive i/o patterns you can acheive very high throughput rates in this mode\&.
611 .PP
612 Note: you can use LVS and public addresses at the same time\&.
613 .SS "Configuration"
614 .PP
615 To activate LVS on a CTDB node you must specify CTDB_PUBLIC_INTERFACE and CTDB_LVS_PUBLIC_ADDRESS in /etc/sysconfig/ctdb\&.
616 .PP
617 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\&.
618 .PP
619 Example:
620 .sp
621 .if n \{\
622 .RS 4
623 .\}
624 .fam C
625 .ps -1
626 .nf
627 .if t \{\
628 .sp -1
629 .\}
630 .BB lightgray adjust-for-leading-newline
631 .sp -1
632
633         CTDB_PUBLIC_INTERFACE=eth0
634         CTDB_LVS_PUBLIC_IP=10\&.0\&.0\&.237
635         
636 .EB lightgray adjust-for-leading-newline
637 .if t \{\
638 .sp 1
639 .\}
640 .fi
641 .fam
642 .ps +1
643 .if n \{\
644 .RE
645 .\}
646 .PP
647 If you use LVS, you must still have a real/permanent address configured for the public interface on each node\&. This address must be routable and the cluster nodes must be configured so that all traffic back to client hosts are routed through this interface\&. This is also required in order to allow samba/winbind on the node to talk to the domain controller\&. (we can not use the lvs IP address to initiate outgoing traffic)
648 .PP
649 I\&.e\&. make sure that you can "ping" both the domain controller and also all of the clients from the node BEFORE you enable LVS\&. Also make sure that when you ping these hosts that the traffic is routed out through the eth0 interface\&.
650 .SH "REMOTE CLUSTER NODES"
651 .PP
652 It is possible to have a CTDB cluster that spans across a WAN link\&. For example where you have a CTDB cluster in your datacentre but you also want to have one additional CTDB node located at a remote branch site\&. This is similar to how a WAN accelerator works but with the difference that while a WAN\-accelerator often acts as a Proxy or a MitM, in the ctdb remote cluster node configuration the Samba instance at the remote site IS the genuine server, not a proxy and not a MitM, and thus provides 100% correct CIFS semantics to clients\&.
653 .PP
654 See the cluster as one single multihomed samba server where one of the NICs (the remote node) is very far away\&.
655 .PP
656 NOTE: This does require that the cluster filesystem you use can cope with WAN\-link latencies\&. Not all cluster filesystems can handle WAN\-link latencies! Whether this will provide very good WAN\-accelerator performance or it will perform very poorly depends entirely on how optimized your cluster filesystem is in handling high latency for data and metadata operations\&.
657 .PP
658 To activate a node as being a remote cluster node you need to set the following two parameters in /etc/sysconfig/ctdb for the remote node:
659 .sp
660 .if n \{\
661 .RS 4
662 .\}
663 .fam C
664 .ps -1
665 .nf
666 .if t \{\
667 .sp -1
668 .\}
669 .BB lightgray adjust-for-leading-newline
670 .sp -1
671
672 CTDB_CAPABILITY_LMASTER=no
673 CTDB_CAPABILITY_RECMASTER=no
674         
675 .EB lightgray adjust-for-leading-newline
676 .if t \{\
677 .sp 1
678 .\}
679 .fi
680 .fam
681 .ps +1
682 .if n \{\
683 .RE
684 .\}
685 .PP
686 Verify with the command "ctdb getcapabilities" that that node no longer has the recmaster or the lmaster capabilities\&.
687 .SH "SEE ALSO"
688 .PP
689 ctdb(1), onnode(1)
690 \m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
691 .SH "COPYRIGHT/LICENSE"
692 .sp
693 .if n \{\
694 .RS 4
695 .\}
696 .fam C
697 .ps -1
698 .nf
699 .if t \{\
700 .sp -1
701 .\}
702 .BB lightgray adjust-for-leading-newline
703 .sp -1
704
705 Copyright (C) Andrew Tridgell 2007
706 Copyright (C) Ronnie sahlberg 2007
707
708 This program is free software; you can redistribute it and/or modify
709 it under the terms of the GNU General Public License as published by
710 the Free Software Foundation; either version 3 of the License, or (at
711 your option) any later version\&.
712
713 This program is distributed in the hope that it will be useful, but
714 WITHOUT ANY WARRANTY; without even the implied warranty of
715 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&.  See the GNU
716 General Public License for more details\&.
717
718 You should have received a copy of the GNU General Public License
719 along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
720 .EB lightgray adjust-for-leading-newline
721 .if t \{\
722 .sp 1
723 .\}
724 .fi
725 .fam
726 .ps +1
727 .if n \{\
728 .RE
729 .\}