5800520932ddf60e6f2d73db8a7835bb472780fe
[ctdb.git] / doc / ctdbd.1
1 '\" t
2 .\"     Title: ctdbd
3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5 .\"      Date: 09/08/2010
6 .\"    Manual: CTDB - clustered TDB database
7 .\"    Source: ctdb
8 .\"  Language: English
9 .\"
10 .TH "CTDBD" "1" "09/08/2010" "ctdb" "CTDB \- clustered TDB database"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 ctdbd \- The CTDB cluster daemon
23 .SH "SYNOPSIS"
24 .HP \w'\fBctdbd\fR\ 'u
25 \fBctdbd\fR
26 .HP \w'\fBctdbd\fR\ 'u
27 \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] {\-\-notification\-script=<filename>} [\-\-public\-addresses=<filename>] [\-\-public\-interface=<interface>] {\-\-reclock=<filename>} [\-\-single\-public\-ip=<address>] [\-\-socket=<filename>] [\-\-start\-as\-disabled] [\-\-start\-as\-stopped] [\-\-syslog] [\-\-log\-ringbuf\-size=<num\-entries>] [\-\-torture] [\-\-transport=<STRING>] [\-\-usage]
28 .SH "DESCRIPTION"
29 .PP
30 ctdbd is the main ctdb daemon\&.
31 .PP
32 ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures\&.
33 .PP
34 Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services\&.
35 .PP
36 ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures\&.
37 .PP
38 ctdbd is the main component in clustered Samba that provides a high\-availability load\-sharing CIFS server cluster\&.
39 .SH "OPTIONS"
40 .PP
41 \-? \-\-help
42 .RS 4
43 Print some help text to the screen\&.
44 .RE
45 .PP
46 \-d \-\-debug=<DEBUGLEVEL>
47 .RS 4
48 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\&.
49 .RE
50 .PP
51 \-\-dbdir=<directory>
52 .RS 4
53 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\&.
54 .sp
55 This directory would usually be /var/ctdb \&.
56 .RE
57 .PP
58 \-\-dbdir\-persistent=<directory>
59 .RS 4
60 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\&.
61 .sp
62 This directory would usually be /etc/ctdb/persistent \&.
63 .RE
64 .PP
65 \-\-event\-script\-dir=<directory>
66 .RS 4
67 This option is used to specify the directory where the CTDB event scripts are stored\&.
68 .sp
69 This will normally be /etc/ctdb/events\&.d which is part of the ctdb distribution\&.
70 .RE
71 .PP
72 \-i \-\-interactive
73 .RS 4
74 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\&.
75 .RE
76 .PP
77 \-\-listen=<address>
78 .RS 4
79 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\&.
80 .sp
81 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\&.
82 .RE
83 .PP
84 \-\-logfile=<filename>
85 .RS 4
86 This is the file where ctdbd will write its log\&. This is usually /var/log/log\&.ctdb \&.
87 .RE
88 .PP
89 \-\-lvs
90 .RS 4
91 This option is used to activate the LVS capability on a CTDB node\&. Please see the LVS section\&.
92 .RE
93 .PP
94 \-\-nlist=<filename>
95 .RS 4
96 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\&.
97 .sp
98 This file is usually /etc/ctdb/nodes \&.
99 .RE
100 .PP
101 \-\-no\-lmaster
102 .RS 4
103 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\&.
104 .sp
105 Please see the "remote cluster nodes" section for more information\&.
106 .RE
107 .PP
108 \-\-no\-recmaster
109 .RS 4
110 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\&.
111 .sp
112 Please see the "remote cluster nodes" section for more information\&.
113 .RE
114 .PP
115 \-\-nosetsched
116 .RS 4
117 This is a ctdbd debugging option\&. this option is only used when debugging ctdbd\&.
118 .sp
119 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\&.
120 .sp
121 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 don\'t want to attach valgrind or gdb to a real\-time process\&.)
122 .RE
123 .PP
124 \-\-notification\-script=<filename>
125 .RS 4
126 This specifies a script which will be invoked by ctdb when certain state changes occur in ctdbd and when you may want to trigger this to run certain scripts\&.
127 .sp
128 This file is usually /etc/ctdb/notify\&.sh \&.
129 .sp
130 See the NOTIFICATION SCRIPT section below for more information\&.
131 .RE
132 .PP
133 \-\-public_addresses=<filename>
134 .RS 4
135 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\&.
136 .sp
137 This is usually the file /etc/ctdb/public_addresses
138 .RE
139 .PP
140 \-\-public\-interface=<interface>
141 .RS 4
142 This option tells ctdb which interface to attach public\-addresses to and also where to attach the single\-public\-ip when used\&.
143 .sp
144 This is only required when using public ip addresses and only when you don\'t specify the interface explicitly in /etc/ctdb/public_addresses or when you are using \-\-single\-public\-ip\&.
145 .sp
146 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\&.
147 .RE
148 .PP
149 \-\-reclock=<filename>
150 .RS 4
151 This is the name of the lock file stored of the shared cluster filesystem that ctdbd uses to prevent split brains from occuring\&. This file must be stored on shared storage\&.
152 .sp
153 It is possible to run CTDB without a reclock file, but then there will be no protection against split brain if the network becomes partitioned\&. Using CTDB without a reclock file is strongly discouraged\&.
154 .RE
155 .PP
156 \-\-socket=<filename>
157 .RS 4
158 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\&.
159 .sp
160 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\&.
161 .RE
162 .PP
163 \-\-start\-as\-disabled
164 .RS 4
165 This makes the ctdb daemon to be DISABLED when it starts up\&.
166 .sp
167 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\&.
168 .sp
169 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\&.
170 .sp
171 A node that is DISABLED will not host any services and will not be reachable/used by any clients\&.
172 .RE
173 .PP
174 \-\-start\-as\-stopped
175 .RS 4
176 This makes the ctdb daemon to be STOPPED when it starts up\&.
177 .sp
178 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\&.
179 .sp
180 To restart and activate a STOPPED node, the command "ctdb continue" is used\&.
181 .sp
182 A node that is STOPPED will not host any services and will not be reachable/used by any clients\&.
183 .RE
184 .PP
185 \-\-syslog
186 .RS 4
187 Send all log messages to syslog instead of to the ctdb logfile\&.
188 .RE
189 .PP
190 \-\-log\-ringbuf\-size=<num\-entries>
191 .RS 4
192 In addition to the normal loggign to a log file, CTDBD also keeps a in\-memory ringbuffer containing the most recent log entries for all log levels (except DEBUG)\&.
193 .sp
194 This is useful since it allows for keeping continous logs to a file at a reasonable non\-verbose level, but shortly after an incident has occured, a much more detailed log can be pulled from memory\&. This can allow you to avoid having to reproduce an issue due to the on\-disk logs being of insufficient detail\&.
195 .sp
196 This in\-memory ringbuffer contains a fixed number of the most recent entries\&. This is settable at startup either through the \-\-log\-ringbuf\-size argument, or preferably by using CTDB_LOG_RINGBUF_SIZE in the sysconfig file\&.
197 .sp
198 Use the "ctdb getlog" command to access this log\&.
199 .RE
200 .PP
201 \-\-torture
202 .RS 4
203 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\&.
204 .sp
205 You do NOT want to use this option unless you are developing and testing new functionality in ctdbd\&.
206 .RE
207 .PP
208 \-\-transport=<STRING>
209 .RS 4
210 This option specifies which transport to use for ctdbd internode communications\&. The default is "tcp"\&.
211 .sp
212 Currently only "tcp" is supported but "infiniband" might be implemented in the future\&.
213 .RE
214 .PP
215 \-\-usage
216 .RS 4
217 Print useage information to the screen\&.
218 .RE
219 .SH "PRIVATE VS PUBLIC ADDRESSES"
220 .PP
221 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\&.
222 .SS "Private address"
223 .PP
224 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\&.
225 .PP
226 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\&.
227 .PP
228 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\&.
229 .PP
230 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\&.
231
232       Example /etc/ctdb/nodes for a four node cluster:
233       
234 .sp
235 .if n \{\
236 .RS 4
237 .\}
238 .nf
239         10\&.1\&.1\&.1
240         10\&.1\&.1\&.2
241         10\&.1\&.1\&.3
242         10\&.1\&.1\&.4
243       
244 .fi
245 .if n \{\
246 .RE
247 .\}
248 .SS "Public address"
249 .PP
250 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\&.
251 .PP
252 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\&.
253 .PP
254 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\&.
255 .PP
256 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\&.
257
258       Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
259       
260 .sp
261 .if n \{\
262 .RS 4
263 .\}
264 .nf
265         11\&.1\&.1\&.1/24 eth0
266         11\&.1\&.1\&.2/24 eth0
267         11\&.1\&.2\&.1/24 eth1
268         11\&.1\&.2\&.2/24 eth1
269       
270 .fi
271 .if n \{\
272 .RE
273 .\}
274 .PP
275 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\&.
276
277         Example: 4 nodes partitioned into two subgroups :
278         
279 .sp
280 .if n \{\
281 .RS 4
282 .\}
283 .nf
284         Node 0:/etc/ctdb/public_addresses
285                 10\&.1\&.1\&.1/24 eth0
286                 10\&.1\&.1\&.2/24 eth0
287
288         Node 1:/etc/ctdb/public_addresses
289                 10\&.1\&.1\&.1/24 eth0
290                 10\&.1\&.1\&.2/24 eth0
291
292         Node 2:/etc/ctdb/public_addresses
293                 10\&.2\&.1\&.1/24 eth0
294                 10\&.2\&.1\&.2/24 eth0
295
296         Node 3:/etc/ctdb/public_addresses
297                 10\&.2\&.1\&.1/24 eth0
298                 10\&.2\&.1\&.2/24 eth0
299         
300 .fi
301 .if n \{\
302 .RE
303 .\}
304 .PP
305 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\&.
306 .PP
307 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\&.
308 .SH "NODE STATUS"
309 .PP
310 The current status of each node in the cluster can be viewed by the \'ctdb status\' command\&.
311 .PP
312 There are five possible states for a node\&.
313 .PP
314 OK \- This node is fully functional\&.
315 .PP
316 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\&.
317 .PP
318 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\&.
319 .PP
320 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\&.
321 .PP
322 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\&.
323 .PP
324 STOPPED \- A node that is stopped does not host any public ip addresses, nor is it part of the VNNMAP\&. A stopped node can not become LVSMASTER, RECMASTER or NATGW\&. This node does not perticipate in the CTDB cluster but can still be communicated with\&. I\&.e\&. ctdb commands can be sent to it\&.
325 .SH "PUBLIC TUNABLES"
326 .PP
327 These are the public tuneables that can be used to control how ctdb behaves\&.
328 .SS "KeepaliveInterval"
329 .PP
330 Default: 1
331 .PP
332 How often should the nodes send keepalives to eachother\&.
333 .SS "KeepaliveLimit"
334 .PP
335 Default: 5
336 .PP
337 After how many keepalive intervals without any traffic should a node wait until marking the peer as DISCONNECTED\&.
338 .SS "MonitorInterval"
339 .PP
340 Default: 15
341 .PP
342 How often should ctdb run the event scripts to check for a nodes health\&.
343 .SS "TickleUpdateInterval"
344 .PP
345 Default: 20
346 .PP
347 How often will ctdb record and store the "tickle" information used to kickstart stalled tcp connections after a recovery\&.
348 .SS "EventScriptTimeout"
349 .PP
350 Default: 20
351 .PP
352 How long should ctdb let an event script run before aborting it and marking the node unhealthy\&.
353 .SS "RecoveryBanPeriod"
354 .PP
355 Default: 300
356 .PP
357 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\&. Don\'t set to small\&. A node gets banned for a reason and it is usually due to real problems with the node\&.
358 .SS "DatabaseHashSize"
359 .PP
360 Default: 100000
361 .PP
362 Size of the hash chains for the local store of the tdbs that ctdb manages\&.
363 .SS "RerecoveryTimeout"
364 .PP
365 Default: 10
366 .PP
367 Once a recovery has completed, no additional recoveries are permitted until this timeout has expired\&.
368 .SS "EnableBans"
369 .PP
370 Default: 1
371 .PP
372 When set to 0, this disables BANNING completely in the cluster and thus nodes can not get banned, even it they break\&. Don\'t set to 0\&.
373 .SS "DeterministicIPs"
374 .PP
375 Default: 1
376 .PP
377 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\&.
378 .PP
379 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\&.
380 .SS "DisableWhenUnhealthy"
381 .PP
382 Default: 0
383 .PP
384 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\'\&.
385 .PP
386 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\&.
387 .SS "NoIPFailback"
388 .PP
389 Default: 0
390 .PP
391 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\&.
392 .PP
393 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\&.
394 .PP
395 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\&.
396 .SH "LVS"
397 .PP
398 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\&.
399 .PP
400 This is similar to using a layer\-4 loadbalancing switch but with some restrictions\&.
401 .PP
402 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, STOPPED, DISABLED or DISCONNECTED\&. The "ctdb lvs" command is used to show which nodes are currently load\-balanced across\&.
403 .PP
404 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\&.
405 .PP
406 The path used for a client i/o is thus :
407 .sp
408 .if n \{\
409 .RS 4
410 .\}
411 .nf
412         (1) Client sends request packet to LVSMASTER
413         (2) LVSMASTER passes the request on to one node across the internal network\&.
414         (3) Selected node processes the request\&.
415         (4) Node responds back to client\&.
416     
417 .fi
418 .if n \{\
419 .RE
420 .\}
421 .PP
422 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\&.
423 .PP
424 Note: you can use LVS and public addresses at the same time\&.
425 .SS "Configuration"
426 .PP
427 To activate LVS on a CTDB node you must specify CTDB_PUBLIC_INTERFACE and CTDB_LVS_PUBLIC_ADDRESS in /etc/sysconfig/ctdb\&.
428 .PP
429 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\&.
430 .PP
431 Example:
432 .sp
433 .if n \{\
434 .RS 4
435 .\}
436 .nf
437         CTDB_PUBLIC_INTERFACE=eth0
438         CTDB_LVS_PUBLIC_IP=10\&.0\&.0\&.237
439         
440 .fi
441 .if n \{\
442 .RE
443 .\}
444 .PP
445 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)
446 .PP
447 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\&.
448 .SH "REMOTE CLUSTER NODES"
449 .PP
450 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\&.
451 .PP
452 See the cluster as one single multihomed samba server where one of the NICs (the remote node) is very far away\&.
453 .PP
454 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\&.
455 .PP
456 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:
457 .sp
458 .if n \{\
459 .RS 4
460 .\}
461 .nf
462 CTDB_CAPABILITY_LMASTER=no
463 CTDB_CAPABILITY_RECMASTER=no
464         
465 .fi
466 .if n \{\
467 .RE
468 .\}
469 .PP
470 Verify with the command "ctdb getcapabilities" that that node no longer has the recmaster or the lmaster capabilities\&.
471 .SH "NAT-GW"
472 .PP
473 Sometimes it is desireable to run services on the CTDB node which will need to originate outgoing traffic to external servers\&. This might be contacting NIS servers, LDAP servers etc\&. etc\&.
474 .PP
475 This can sometimes be problematic since there are situations when a node does not have any public ip addresses assigned\&. This could be due to the nobe just being started up and no addresses have been assigned yet or it could be that the node is UNHEALTHY in which case all public addresses have been migrated off\&.
476 .PP
477 If then the service status of CTDB depends on such services being able to always being able to originate traffic to external resources this becomes extra troublesome\&. The node might be UNHEALTHY because the service can not be reached, and the service can not be reached because the node is UNHEALTHY\&.
478 .PP
479 There are two ways to solve this problem\&. The first is by assigning a static ip address for one public interface on every node which will allow every node to be able to route traffic to the public network even if there are no public addresses assigned to the node\&. This is the simplest way but it uses up a lot of ip addresses since you have to assign both static and also public addresses to each node\&.
480 .SS "NAT\-GW"
481 .PP
482 A second way is to use the built in NAT\-GW feature in CTDB\&. With NAT\-GW you assign one public NATGW address for each natgw group\&. Each NATGW group is a set of nodes in the cluster that shares the same NATGW address to talk to the outside world\&. Normally there would only be one NATGW group spanning the entire cluster, but in situations where one ctdb cluster spans multiple physical sites it is useful to have one NATGW group for each of the two sites\&.
483 .PP
484 There can be multiple NATGW groups in one cluster but each node can only be member of one NATGW group\&.
485 .PP
486 In each NATGW group, one of the nodes is designated the NAT Gateway through which all traffic that is originated by nodes in this group will be routed through if a public addresses are not available\&.
487 .SS "Configuration"
488 .PP
489 NAT\-GW is configured in /etc/sysconfigctdb by setting the following variables:
490 .sp
491 .if n \{\
492 .RS 4
493 .\}
494 .nf
495 # NAT\-GW configuration
496 # Some services running on nthe CTDB node may need to originate traffic to
497 # remote servers before the node is assigned any IP addresses,
498 # This is problematic since before the node has public addresses the node might
499 # not be able to route traffic to the public networks\&.
500 # One solution is to have static public addresses assigned with routing
501 # in addition to the public address interfaces, thus guaranteeing that
502 # a node always can route traffic to the external network\&.
503 # This is the most simple solution but it uses up a large number of 
504 # additional ip addresses\&.
505 #
506 # A more complex solution is NAT\-GW\&.
507 # In this mode we only need one additional ip address for the cluster from
508 # the exsternal public network\&.
509 # One of the nodes in the cluster is elected to be hosting this ip address
510 # so it can reach the external services\&. This node is also configured
511 # to use NAT MASQUERADING for all traffic from the internal private network
512 # to the external network\&. This node is the NAT\-GW node\&.
513 #
514 # All other nodes are set up with a default rote with a metric of 10 to point
515 # to the nat\-gw node\&.
516
517 # The effect of this is that only when a node does not have a public address
518 # and thus no proper routes to the external world it will instead
519 # route all packets through the nat\-gw node\&.
520 #
521 # CTDB_NATGW_NODES is the list of nodes that belong to this natgw group\&.
522 # You can have multiple natgw groups in one cluster but each node
523 # can only belong to one single natgw group\&.
524 #
525 # CTDB_NATGW_PUBLIC_IP=10\&.0\&.0\&.227/24
526 # CTDB_NATGW_PUBLIC_IFACE=eth0
527 # CTDB_NATGW_DEFAULT_GATEWAY=10\&.0\&.0\&.1
528 # CTDB_NATGW_PRIVATE_NETWORK=10\&.1\&.1\&.0/24
529 # CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
530 #
531 # Normally any node in the natgw group can act as the natgw master\&.
532 # In some configurations you may have special nodes that is a part of the
533 # cluster/natgw group, but where the node lacks connectivity to the 
534 # public network\&.
535 # For these cases, set this variable to make these nodes not able to
536 # become natgw master\&.
537 #
538 # CTDB_NATGW_SLAVE_ONLY=yes
539     
540 .fi
541 .if n \{\
542 .RE
543 .\}
544 .SS "CTDB_NATGW_PUBLIC_IP"
545 .PP
546 This is an ip address in the public network that is used for all outgoing traffic when the public addresses are not assigned\&. This address will be assigned to one of the nodes in the cluster which will masquerade all traffic for the other nodes\&.
547 .PP
548 Format of this parameter is IPADDRESS/NETMASK
549 .SS "CTDB_NATGW_PUBLIC_IFACE"
550 .PP
551 This is the physical interface where the CTDB_NATGW_PUBLIC_IP will be assigned to\&. This should be an interface connected to the public network\&.
552 .PP
553 Format of this parameter is INTERFACE
554 .SS "CTDB_NATGW_DEFAULT_GATEWAY"
555 .PP
556 This is the default gateway to use on the node that is elected to host the CTDB_NATGW_PUBLIC_IP\&. This is the default gateway on the public network\&.
557 .PP
558 Format of this parameter is IPADDRESS
559 .SS "CTDB_NATGW_PRIVATE_NETWORK"
560 .PP
561 This is the network/netmask used for the interal private network\&.
562 .PP
563 Format of this parameter is IPADDRESS/NETMASK
564 .SS "CTDB_NATGW_NODES"
565 .PP
566 This is the list of all nodes that belong to the same NATGW group as this node\&. The default is /etc/ctdb/natgw_nodes\&.
567 .SS "Operation"
568 .PP
569 When the NAT\-GW functionality is used, one of the nodes is elected to act as a NAT router for all the other nodes in the group when they need to originate traffic to the external public network\&.
570 .PP
571 The NAT\-GW node is assigned the CTDB_NATGW_PUBLIC_IP to the designated interface and the provided default route\&. The NAT\-GW is configured to act as a router and to masquerade all traffic it receives from the internal private network and which is destined to the external network(s)\&.
572 .PP
573 All other nodes in the group are configured with a default route of metric 10 pointing to the designated NAT GW node\&.
574 .PP
575 This is implemented in the 11\&.natgw eventscript\&. Please see the eventscript for further information\&.
576 .SS "Removing/Changing NATGW at runtime"
577 .PP
578 The following are the procedures to change/remove a NATGW configuration at runtime, without having to restart ctdbd\&.
579 .PP
580 If you want to remove NATGW completely from a node, use these steps:
581 .sp
582 .if n \{\
583 .RS 4
584 .\}
585 .nf
586 1, Run \'CTDB_BASE=/etc/ctdb /etc/ctdb/events\&.d/11\&.natgw removenatgw\'
587 2, Then remove the configuration from /etc/sysconfig/ctdb
588     
589 .fi
590 .if n \{\
591 .RE
592 .\}
593 .PP
594 If you want to change the NATGW configuration on a node :
595 .sp
596 .if n \{\
597 .RS 4
598 .\}
599 .nf
600 1, Run \'CTDB_BASE=/etc/ctdb /etc/ctdb/events\&.d/11\&.natgw removenatgw\'
601 2, Then change the configuration in /etc/sysconfig/ctdb
602 3, Run \'CTDB_BASE=/etc/ctdb /etc/ctdb/events\&.d/11\&.natgw updatenatgw\'
603     
604 .fi
605 .if n \{\
606 .RE
607 .\}
608 .SH "NOTIFICATION SCRIPT"
609 .PP
610 Notification scripts are used with ctdb to have a call\-out from ctdb to a user\-specified script when certain state changes occur in ctdb\&. This is commonly to set up either sending SNMP traps or emails when a node becomes unhealthy and similar\&.
611 .PP
612 This is activated by setting CTDB_NOTIFY_SCRIPT=<your script> in the sysconfig file, or by adding \-\-notification\-script=<your script>\&.
613 .PP
614 See /etc/ctdb/notify\&.sh for an example script\&.
615 .PP
616 CTDB currently generates notifications on these state changes:
617 .SS "unhealthy"
618 .PP
619 This call\-out is triggered when the node changes to UNHEALTHY state\&.
620 .SS "healthy"
621 .PP
622 This call\-out is triggered when the node changes to HEALTHY state\&.
623 .SS "startup"
624 .PP
625 This call\-out is triggered when ctdb has started up and all managed services are up and running\&.
626 .SH "CLAMAV DAEMON"
627 .PP
628 CTDB has support to manage the popular anti\-virus daemon ClamAV\&. This support is implemented through the eventscript : /etc/ctdb/events\&.d/31\&.clamd\&.
629 .SS "Configuration"
630 .PP
631 Start by configuring CLAMAV normally and test that it works\&. Once this is done, copy the configuration files over to all the nodes so that all nodes share identical CLAMAV configurations\&. Once this is done you can proceed with the intructions below to activate CTDB support for CLAMAV\&.
632 .PP
633 First, to activate CLAMAV support in CTDB, edit /etc/sysconfig/ctdb and add the two lines :
634 .sp
635 .if n \{\
636 .RS 4
637 .\}
638 .nf
639 CTDB_MANAGES_CLAMD=yes
640 CTDB_CLAMD_SOCKET="/path/to/clamd\&.socket"
641 .fi
642 .if n \{\
643 .RE
644 .\}
645 .PP
646 Second, activate the eventscript
647 .sp
648 .if n \{\
649 .RS 4
650 .\}
651 .nf
652 ctdb enablescript 31\&.clamd
653 .fi
654 .if n \{\
655 .RE
656 .\}
657 .PP
658 Third, CTDB will now be starting and stopping this service accordingly, so make sure that the system is not configured to start/stop this service automatically\&. On RedHat systems you can disable the system starting/stopping CLAMAV automatically by running :
659 .sp
660 .if n \{\
661 .RS 4
662 .\}
663 .nf
664 chkconfig clamd off
665 .fi
666 .if n \{\
667 .RE
668 .\}
669 .PP
670 Once you have restarted CTDBD, use
671 .sp
672 .if n \{\
673 .RS 4
674 .\}
675 .nf
676 ctdb scriptstatus
677 .fi
678 .if n \{\
679 .RE
680 .\}
681 .sp
682 and verify that the 31\&.clamd eventscript is listed and that it was executed successfully\&.
683 .SH "SEE ALSO"
684 .PP
685 ctdb(1), onnode(1)
686 \m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
687 .SH "COPYRIGHT/LICENSE"
688 .sp
689 .if n \{\
690 .RS 4
691 .\}
692 .nf
693 Copyright (C) Andrew Tridgell 2007
694 Copyright (C) Ronnie sahlberg 2007
695
696 This program is free software; you can redistribute it and/or modify
697 it under the terms of the GNU General Public License as published by
698 the Free Software Foundation; either version 3 of the License, or (at
699 your option) any later version\&.
700
701 This program is distributed in the hope that it will be useful, but
702 WITHOUT ANY WARRANTY; without even the implied warranty of
703 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&.  See the GNU
704 General Public License for more details\&.
705
706 You should have received a copy of the GNU General Public License
707 along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
708 .fi
709 .if n \{\
710 .RE
711 .\}