Merge commit 'origin/master'
[metze/ctdb/wip.git] / doc / ctdbd.1.html
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.73.2"></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 &#8212; 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>  [-? --help] [-d --debug=&lt;INTEGER&gt;] {--dbdir=&lt;directory&gt;} {--dbdir-persistent=&lt;directory&gt;} [--event-script-dir=&lt;directory&gt;] [-i --interactive] [--listen=&lt;address&gt;] [--logfile=&lt;filename&gt;] [--lvs] {--nlist=&lt;filename&gt;} [--no-lmaster] [--no-recmaster] [--nosetsched] [--public-addresses=&lt;filename&gt;] [--public-interface=&lt;interface&gt;] {--reclock=&lt;filename&gt;} [--single-public-ip=&lt;address&gt;] [--socket=&lt;filename&gt;] [--start-as-disabled] [--syslog] [--torture] [--transport=&lt;STRING&gt;] [--usage]</p></div></div><div class="refsect1" lang="en"><a name="id2479648"></a><h2>DESCRIPTION</h2><p>
2       ctdbd is the main ctdb daemon.
3     </p><p>
4       ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
5     </p><p>
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.
7     </p><p>
8       ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
9     </p><p>
10       ctdbd is the main component in clustered Samba that provides a high-availability load-sharing CIFS server cluster.
11     </p></div><div class="refsect1" lang="en"><a name="id2479679"></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">-d --debug=&lt;DEBUGLEVEL&gt;</span></dt><dd><p>
14             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.
15           </p></dd><dt><span class="term">--dbdir=&lt;directory&gt;</span></dt><dd><p>
16             This is the directory on local storage where ctdbd keeps the local
17             copy of the TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
18           </p><p>
19             This directory would usually be /var/ctdb .
20           </p></dd><dt><span class="term">--dbdir-persistent=&lt;directory&gt;</span></dt><dd><p>
21             This is the directory on local storage where ctdbd keeps the local
22             copy of the persistent TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
23           </p><p>
24             This directory would usually be /etc/ctdb/persistent .
25           </p></dd><dt><span class="term">--event-script-dir=&lt;directory&gt;</span></dt><dd><p>
26             This option is used to specify the directory where the CTDB event
27             scripts are stored.
28           </p><p>
29             This will normally be /etc/ctdb/events.d which is part of the ctdb distribution.
30           </p></dd><dt><span class="term">-i --interactive</span></dt><dd><p>
31             By default ctdbd will detach itself from the shell and run in
32             the background as a daemon. This option makes ctdbd to start in interactive mode.
33           </p></dd><dt><span class="term">--listen=&lt;address&gt;</span></dt><dd><p>
34             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.
35           </p><p>
36             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.
37           </p></dd><dt><span class="term">--logfile=&lt;filename&gt;</span></dt><dd><p>
38             This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
39           </p></dd><dt><span class="term">--lvs</span></dt><dd><p>
40           This option is used to activate the LVS capability on a CTDB node.
41           Please see the LVS section.
42           </p></dd><dt><span class="term">--nlist=&lt;filename&gt;</span></dt><dd><p>
43             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.
44           </p><p>
45             This file is usually /etc/ctdb/nodes .
46           </p></dd><dt><span class="term">--no-lmaster</span></dt><dd><p>
47           This argument specifies that this node can NOT become an lmaster
48           for records in the database. This means that it will never show up
49           in the vnnmap. This feature is primarily used for making a cluster
50         span across a WAN link and use CTDB as a WAN-accelerator.
51           </p><p>
52           Please see the "remote cluster nodes" section for more information.
53           </p></dd><dt><span class="term">--no-recmaster</span></dt><dd><p>
54           This argument specifies that this node can NOT become a recmaster
55           for the database. This feature is primarily used for making a cluster
56         span across a WAN link and use CTDB as a WAN-accelerator.
57           </p><p>
58           Please see the "remote cluster nodes" section for more information.
59           </p></dd><dt><span class="term">--nosetsched</span></dt><dd><p>
60             This is a ctdbd debugging option. this option is only used when
61             debugging ctdbd.
62           </p><p>
63             Normally ctdb will change its scheduler to run as a real-time 
64             process. This is the default mode for a normal ctdbd operation
65             to gurarantee that ctdbd always gets the cpu cycles that it needs.
66           </p><p>
67             This option is used to tell ctdbd to NOT run as a real-time process
68             and instead run ctdbd as a normal userspace process.
69             This is useful for debugging and when you want to run ctdbd under
70             valgrind or gdb. (You dont want to attach valgrind or gdb to a
71             real-time process.)
72           </p></dd><dt><span class="term">--public_addresses=&lt;filename&gt;</span></dt><dd><p>
73             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.
74           </p><p>
75             This is usually the file /etc/ctdb/public_addresses
76           </p></dd><dt><span class="term">--public-interface=&lt;interface&gt;</span></dt><dd><p>
77             This option tells ctdb which interface to attach public-addresses
78             to and also where to attach the single-public-ip when used.
79             </p><p>
80             This is only required when using public ip addresses and only when
81             you dont specify the interface explicitly in /etc/ctdb/public_addresses or when you are using --single-public-ip.
82           </p><p>
83           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. 
84           </p></dd><dt><span class="term">--reclock=&lt;filename&gt;</span></dt><dd><p>
85             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.
86             This file must be stored on shared storage.
87           </p></dd><dt><span class="term">--socket=&lt;filename&gt;</span></dt><dd><p>
88             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.
89           </p><p>
90             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.
91           </p></dd><dt><span class="term">--start-as-disabled</span></dt><dd><p>
92           This makes the ctdb daemon to be DISABLED when it starts up.
93           </p><p>
94           As it is DISABLED it will not get any of the public ip addresses
95           allocated to it, and thus this allow you to start ctdb on a node 
96           without causing any ip address to failover from other nodes onto
97           the new node.
98           </p><p>
99           When used, the administrator must keep track of when nodes start and
100           manually enable them again using the "ctdb enable" command, or else
101           the node will not host any services.
102           </p><p>
103           A node that is DISABLED will not host any services and will not be
104           reachable/used by any clients.
105           </p></dd><dt><span class="term">--syslog</span></dt><dd><p>
106             Send all log messages to syslog instead of to the ctdb logfile.
107           </p></dd><dt><span class="term">--torture</span></dt><dd><p>
108             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.
109           </p><p>
110             You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
111           </p></dd><dt><span class="term">--transport=&lt;STRING&gt;</span></dt><dd><p>
112             This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
113           </p><p>
114             Currently only "tcp" is supported but "infiniband" might be
115             implemented in the future.
116           </p></dd><dt><span class="term">--usage</span></dt><dd><p>
117             Print useage information to the screen.
118           </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2528779"></a><h2>Private vs Public addresses</h2><p>
119       When used for ip takeover in a HA environment, each node in a ctdb 
120       cluster has multiple ip addresses assigned to it. One private and one or more public.
121     </p><div class="refsect2" lang="en"><a name="id2528790"></a><h3>Private address</h3><p>
122         This is the physical ip address of the node which is configured in 
123         linux and attached to a physical interface. This address uniquely
124         identifies a physical node in the cluster and is the ip addresses
125         that ctdbd will use to communicate with the ctdbd daemons on the
126         other nodes in the cluster.
127       </p><p>
128         The private addresses are configured in /etc/ctdb/nodes 
129         (unless the --nlist option is used) and contain one line for each 
130         node in the cluster. Each line contains the private ip address for one
131         node in the cluster. This file must be the same on all nodes in the
132         cluster.
133       </p><p>
134         Since the private addresses are only available to the network when the
135         corresponding node is up and running you should not use these addresses
136         for clients to connect to services provided by the cluster. Instead
137         client applications should only attach to the public addresses since
138         these are guaranteed to always be available.
139       </p><p>
140         When using ip takeover, it is strongly recommended that the private 
141         addresses are configured on a private network physically separated
142         from the rest of the network and that this private network is dedicated
143         to CTDB traffic.
144       </p>
145       Example /etc/ctdb/nodes for a four node cluster:
146       <pre class="screen">
147         10.1.1.1
148         10.1.1.2
149         10.1.1.3
150         10.1.1.4
151       </pre></div><div class="refsect2" lang="en"><a name="id2528838"></a><h3>Public address</h3><p>
152         A public address on the other hand is not attached to an interface.
153         This address is managed by ctdbd itself and is attached/detached to
154         a physical node at runtime.
155       </p><p>
156         The ctdb cluster will assign/reassign these public addresses across the
157         available healthy nodes in the cluster. When one node fails, its public address
158         will be migrated to and taken over by a different node in the cluster
159         to ensure that all public addresses are always available to clients as 
160         long as there are still nodes available capable of hosting this address.
161       </p><p>
162         These addresses are not physically attached to a specific node. 
163         The 'ctdb ip' command can be used to view the current assignment of 
164         public addresses and which physical node is currently serving it.
165       </p><p>
166         On each node this file contains a list of the public addresses that 
167         this node is capable of hosting.
168         The list also contain the netmask and the 
169         interface where this address should be attached for the case where you
170         may want to serve data out through multiple different interfaces.
171       </p>
172       Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
173       <pre class="screen">
174         11.1.1.1/24 eth0
175         11.1.1.2/24 eth0
176         11.1.2.1/24 eth1
177         11.1.2.2/24 eth1
178       </pre><p>
179         In most cases this file would be the same on all nodes in a cluster but
180         there are exceptions when one may want to use different files
181         on different nodes.
182         </p>
183         Example: 4 nodes partitioned into two subgroups :
184         <pre class="screen">
185         Node 0:/etc/ctdb/public_addresses
186                 10.1.1.1/24 eth0
187                 10.1.1.2/24 eth0
188
189         Node 1:/etc/ctdb/public_addresses
190                 10.1.1.1/24 eth0
191                 10.1.1.2/24 eth0
192
193         Node 2:/etc/ctdb/public_addresses
194                 10.2.1.1/24 eth0
195                 10.2.1.2/24 eth0
196
197         Node 3:/etc/ctdb/public_addresses
198                 10.2.1.1/24 eth0
199                 10.2.1.2/24 eth0
200         </pre><p>
201         In this example nodes 0 and 1 host two public addresses on the 
202         10.1.1.x network  while nodes 2 and 3 host two public addresses for the 
203         10.2.1.x network.
204         </p><p>
205         Ip address 10.1.1.1 can be hosted by either of nodes 0 or 1 and will be
206         available to clients as long as at least one of these two nodes are
207         available.
208         If both nodes 0 and node 1 become unavailable 10.1.1.1 also becomes 
209         unavailable. 10.1.1.1 can not be failed over to node 2 or node 3 since
210         these nodes do not have this ip address listed in their public
211         addresses file.
212         </p></div></div><div class="refsect1" lang="en"><a name="id2528920"></a><h2>Node status</h2><p>
213       The current status of each node in the cluster can be viewed by the 
214       'ctdb status' command.
215     </p><p>
216       There are five possible states for a node.
217     </p><p>
218       OK - This node is fully functional.
219     </p><p>
220       DISCONNECTED - This node could not be connected through the network 
221       and is currently not particpating in the cluster. If there is a 
222       public IP address associated with this node it should have been taken 
223       over by a different node. No services are running on this node.
224     </p><p>
225       DISABLED - This node has been administratively disabled. This node is 
226       still functional and participates in the CTDB cluster but its IP 
227       addresses have been taken over by a different node and no services are 
228       currently being hosted.
229     </p><p>
230       UNHEALTHY - A service provided by this node is malfunctioning and should 
231       be investigated. The CTDB daemon itself is operational and participates 
232       in the cluster. Its public IP address has been taken over by a different 
233       node and no services are currently being hosted. All unhealthy nodes 
234       should be investigated and require an administrative action to rectify.
235     </p><p>
236       BANNED - This node failed too many recovery attempts and has been banned 
237       from participating in the cluster for a period of RecoveryBanPeriod 
238       seconds. Any public IP address has been taken over by other nodes. This 
239       node does not provide any services. All banned nodes should be 
240       investigated and require an administrative action to rectify. This node 
241       does not perticipate in the CTDB cluster but can still be communicated 
242       with. I.e. ctdb commands can be sent to it.
243     </p></div><div class="refsect1" lang="en"><a name="id2528977"></a><h2>PUBLIC TUNABLES</h2><p>
244     These are the public tuneables that can be used to control how ctdb behaves.
245     </p><div class="refsect2" lang="en"><a name="id2528988"></a><h3>KeepaliveInterval</h3><p>Default: 1</p><p>
246     How often should the nodes send keepalives to eachother.
247     </p></div><div class="refsect2" lang="en"><a name="id2529001"></a><h3>KeepaliveLimit</h3><p>Default: 5</p><p>
248     After how many keepalive intervals without any traffic should a node
249     wait until marking the peer as DISCONNECTED.
250     </p></div><div class="refsect2" lang="en"><a name="id2529016"></a><h3>MonitorInterval</h3><p>Default: 15</p><p>
251     How often should ctdb run the event scripts to check for a nodes health.
252     </p></div><div class="refsect2" lang="en"><a name="id2529030"></a><h3>TickleUpdateInterval</h3><p>Default: 20</p><p>
253     How often will ctdb record and store the "tickle" information used to
254     kickstart stalled tcp connections after a recovery.
255     </p></div><div class="refsect2" lang="en"><a name="id2529044"></a><h3>EventScriptTimeout</h3><p>Default: 20</p><p>
256     How long should ctdb let an event script run before aborting it and
257     marking the node unhealthy.
258     </p></div><div class="refsect2" lang="en"><a name="id2529059"></a><h3>RecoveryBanPeriod</h3><p>Default: 300</p><p>
259     If a node becomes banned causing repetitive recovery failures. The node will
260     eventually become banned from the cluster.
261     This controls how long the culprit node will be banned from the cluster
262     before it is allowed to try to join the cluster again.
263     Dont set to small. A node gets banned for a reason and it is usually due
264     to real problems with the node.
265     </p></div><div class="refsect2" lang="en"><a name="id2529078"></a><h3>DatabaseHashSize</h3><p>Default: 100000</p><p>
266     Size of the hash chains for the local store of the tdbs that ctdb manages.
267     </p></div><div class="refsect2" lang="en"><a name="id2529092"></a><h3>RerecoveryTimeout</h3><p>Default: 10</p><p>
268     Once a recovery has completed, no additional recoveries are permitted until this timeout has expired.
269     </p></div><div class="refsect2" lang="en"><a name="id2529106"></a><h3>EnableBans</h3><p>Default: 1</p><p>
270     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.
271     </p></div><div class="refsect2" lang="en"><a name="id2529121"></a><h3>DeterministicIPs</h3><p>Default: 1</p><p>
272     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. 
273     </p><p>
274     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.
275     </p></div><div class="refsect2" lang="en"><a name="id2529146"></a><h3>DisableWhenUnhealthy</h3><p>Default: 0</p><p>
276     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'. 
277     </p><p>
278     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.
279     </p></div><div class="refsect2" lang="en"><a name="id2529170"></a><h3>NoIPFailback</h3><p>Default: 0</p><p>
280     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.
281     </p><p>
282     Use with caution! Normally when a node becomes available to the cluster
283 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.
284     </p><p>
285     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.
286     </p></div></div><div class="refsect1" lang="en"><a name="id2529206"></a><h2>LVS</h2><p>
287     LVS is a mode where CTDB presents one single IP address for the entire
288     cluster. This is an alternative to using public IP addresses and round-robin
289     DNS to loadbalance clients across the cluster.
290     </p><p>
291     This is similar to using a layer-4 loadbalancing switch but with some restrictions.
292     </p><p>
293     In this mode the cluster select a set of nodes in the cluster and loadbalance
294     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
295     all LVS capable nodes regardless of health status.
296     LVS will however never loadbalance traffic to nodes that are BANNED,
297     DISABLED or DISCONNECTED. The "ctdb lvs" command is used to show
298     which nodes are currently load-balanced across.
299     </p><p>
300     One of the these nodes are elected as the LVSMASTER. This node receives all
301     traffic from clients coming in to the LVS address and multiplexes it
302     across the internal network to one of the nodes that LVS is using.
303     When responding to the client, that node will send the data back
304     directly to the client, bypassing the LVSMASTER node.
305     The command "ctdb lvsmaster" will show which node is the current
306     LVSMASTER.
307     </p><p>
308     The path used for a client i/o is thus :
309     </p><pre class="screen">
310         (1) Client sends request packet to LVSMASTER
311         (2) LVSMASTER passes the request on to one node across the internal network.
312         (3) Selected node processes the request.
313         (4) Node responds back to client.
314     </pre><p>
315     </p><p> 
316     This means that all incoming traffic to the cluster will pass through
317     one physical node, which limits scalability. You can send more data to the
318     LVS address that one physical node can multiplex. This means that you 
319     should not use LVS if your I/O pattern is write-intensive since you will be
320     limited in the available network bandwidth that node can handle.
321     LVS does work wery well for read-intensive workloads where only smallish
322     READ requests are going through the LVSMASTER bottleneck and the majority
323     of the traffic volume (the data in the read replies) goes straight from
324     the processing node back to the clients. For read-intensive i/o patterns you can acheive very high throughput rates in this mode.
325     </p><p>
326     Note: you can use LVS and public addresses at the same time.
327     </p><div class="refsect2" lang="en"><a name="id2529279"></a><h3>Configuration</h3><p>
328     To activate LVS on a CTDB node you must specify CTDB_PUBLIC_INTERFACE and 
329     CTDB_LVS_PUBLIC_ADDRESS in /etc/sysconfig/ctdb.
330         </p><p>
331 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.
332         </p><p>
333         Example:
334     </p><pre class="screen">
335         CTDB_PUBLIC_INTERFACE=eth0
336         CTDB_LVS_PUBLIC_IP=10.0.0.237
337         </pre><p>
338         </p></div><p>
339     If you use LVS, you must still have a real/permanent address configured
340     for the public interface on each node. This address must be routable
341     and the cluster nodes must be configured so that all traffic back to client
342     hosts are routed through this interface. This is also required in order
343     to allow samba/winbind on the node to talk to the domain controller.
344     (we can not use the lvs IP address to initiate outgoing traffic)
345     </p><p>
346     I.e. make sure that you can "ping" both the domain controller and also
347     all of the clients from the node BEFORE you enable LVS. Also make sure
348     that when you ping these hosts that the traffic is routed out through the
349     eth0 interface.
350     </p></div><div class="refsect1" lang="en"><a name="id2529326"></a><h2>REMOTE CLUSTER NODES</h2><p>
351 It is possible to have a CTDB cluster that spans across a WAN link. 
352 For example where you have a CTDB cluster in your datacentre but you also
353 want to have one additional CTDB node located at a remote branch site.
354 This is similar to how a WAN accelerator works but with the difference 
355 that while a WAN-accelerator often acts as a Proxy or a MitM, in 
356 the ctdb remote cluster node configuration the Samba instance at the remote site
357 IS the genuine server, not a proxy and not a MitM, and thus provides 100%
358 correct CIFS semantics to clients.
359     </p><p>
360         See the cluster as one single multihomed samba server where one of
361         the NICs (the remote node) is very far away.
362     </p><p>
363         NOTE: This does require that the cluster filesystem you use can cope
364         with WAN-link latencies. Not all cluster filesystems can handle
365         WAN-link latencies! Whether this will provide very good WAN-accelerator
366         performance or it will perform very poorly depends entirely
367         on how optimized your cluster filesystem is in handling high latency
368         for data and metadata operations.
369     </p><p>
370         To activate a node as being a remote cluster node you need to set
371         the following two parameters in /etc/sysconfig/ctdb  for the remote node:
372         </p><pre class="screen">
373 CTDB_CAPABILITY_LMASTER=no
374 CTDB_CAPABILITY_RECMASTER=no
375         </pre><p>
376     </p><p>
377         Verify with the command "ctdb getcapabilities" that that node no longer
378         has the recmaster or the lmaster capabilities.
379     </p></div><div class="refsect1" lang="en"><a name="id2529386"></a><h2>NAT-GW</h2><p>
380       Sometimes it is desireable to run services on the CTDB node which will
381       need to originate outgoing traffic to external servers. This might
382       be contacting NIS servers, LDAP servers etc. etc.
383     </p><p>
384       This can sometimes be problematic since there are situations when a
385       node does not have any public ip addresses assigned. This could
386       be due to the nobe just being started up and no addresses have been
387       assigned yet or it could be that the node is UNHEALTHY in which
388       case all public addresses have been migrated off.
389     </p><p>
390       If then the service status of CTDB depends on such services being
391       able to always being able to originate traffic to external resources
392       this becomes extra troublesome. The node might be UNHEALTHY because
393       the service can not be reached, and the service can not be reached
394       because the node is UNHEALTHY.
395     </p><p>
396       There are two ways to solve this problem. The first is by assigning a
397       static ip address for one public interface on every node which will allow
398       every node to be able to route traffic to the public network even
399       if there are no public addresses assigned to the node.
400       This is the simplest way but it uses up a lot of ip addresses since you
401       have to assign both static and also public addresses to each node.
402     </p><div class="refsect2" lang="en"><a name="id2529426"></a><h3>NAT-GW</h3><p>
403       A second way is to use the built in NAT-GW feature in CTDB.
404       With NAT-GW you assign one public NATGW address for each natgw group.
405       Each NATGW group is a set of nodes in the cluster that shares the same
406       NATGW address to talk to the outside world. Normally there would only be
407       one NATGW group spanning the entire cluster, but in situations where one
408       ctdb cluster spans multiple physical sites it is useful to have one
409       NATGW group for each of the two sites.
410     </p><p>
411       There can be multiple NATGW groups in one cluster but each node can only
412       be member of one NATGW group.
413     </p><p>
414       In each NATGW group, one of the nodes is designated the NAT Gateway
415       through which all traffic that is originated by nodes in this group
416       will be routed through if a public addresses are not available. 
417     </p></div><div class="refsect2" lang="en"><a name="id2529456"></a><h3>Configuration</h3><p>
418       NAT-GW is configured in /etc/sysconfigctdb by setting the following
419       variables:
420     </p><pre class="screen">
421 # NAT-GW configuration
422 # Some services running on nthe CTDB node may need to originate traffic to
423 # remote servers before the node is assigned any IP addresses,
424 # This is problematic since before the node has public addresses the node might
425 # not be able to route traffic to the public networks.
426 # One solution is to have static public addresses assigned with routing
427 # in addition to the public address interfaces, thus guaranteeing that
428 # a node always can route traffic to the external network.
429 # This is the most simple solution but it uses up a large number of 
430 # additional ip addresses.
431 #
432 # A more complex solution is NAT-GW.
433 # In this mode we only need one additional ip address for the cluster from
434 # the exsternal public network.
435 # One of the nodes in the cluster is elected to be hosting this ip address
436 # so it can reach the external services. This node is also configured
437 # to use NAT MASQUERADING for all traffic from the internal private network
438 # to the external network. This node is the NAT-GW node.
439 #
440 # All other nodes are set up with a default rote with a metric of 10 to point
441 # to the nat-gw node.
442
443 # The effect of this is that only when a node does not have a public address
444 # and thus no proper routes to the external world it will instead
445 # route all packets through the nat-gw node.
446 #
447 # CTDB_NATGW_NODES is the list of nodes that belong to this natgw group.
448 # You can have multiple natgw groups in one cluster but each node
449 # can only belong to one single natgw group.
450 #
451 # CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
452 # CTDB_NATGW_PUBLIC_IFACE=eth0
453 # CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
454 # CTDB_NATGW_PRIVATE_NETWORK=10.1.1.0/24
455 # CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
456     </pre></div><div class="refsect2" lang="en"><a name="id2529529"></a><h3>CTDB_NATGW_PUBLIC_IP</h3><p>
457       This is an ip address in the public network that is used for all outgoing
458       traffic when the public addresses are not assigned.
459       This address will be assigned to one of the nodes in the cluster which
460       will masquerade all traffic for the other nodes.
461     </p><p>
462       Format of this parameter is IPADDRESS/NETMASK
463     </p></div><div class="refsect2" lang="en"><a name="id2529546"></a><h3>CTDB_NATGW_PUBLIC_IFACE</h3><p>
464       This is the physical interface where the CTDB_NATGW_PUBLIC_IP will be
465       assigned to. This should be an interface connected to the public network.
466     </p><p>
467       Format of this parameter is INTERFACE
468     </p></div><div class="refsect2" lang="en"><a name="id2529562"></a><h3>CTDB_NATGW_DEFAULT_GATEWAY</h3><p>
469       This is the default gateway to use on the node that is elected to host
470       the CTDB_NATGW_PUBLIC_IP. This is the default gateway on the public network.
471     </p><p>
472       Format of this parameter is IPADDRESS
473     </p></div><div class="refsect2" lang="en"><a name="id2476133"></a><h3>CTDB_NATGW_PRIVATE_NETWORK</h3><p>
474       This is the network/netmask used for the interal private network.
475     </p><p>
476       Format of this parameter is IPADDRESS/NETMASK
477     </p></div><div class="refsect2" lang="en"><a name="id2476148"></a><h3>CTDB_NATGW_NODES</h3><p>
478       This is the list of all nodes that belong to the same NATGW group
479       as this node. The default is /etc/ctdb/natgw_nodes.
480     </p></div><div class="refsect2" lang="en"><a name="id2476159"></a><h3>Operation</h3><p>
481       When the NAT-GW fiunctionality is used, one of the nodes is elected
482       to act as a NAT router for all the other nodes in the group when
483       they need to originate traffic to the external public network.
484     </p><p>
485       The NAT-GW node is assigned the CTDB_NATGW_PUBLIC_IP to the designated
486       interface and the provided default route. The NAT-GW is configured
487       to act as a router and to masquerade all traffic it receives from the
488       internal private network and which is destined to the external network(s).
489     </p><p>
490       All other nodes in the group are configured with a default route of
491       metric 10 pointing to the designated NAT GW node.
492     </p><p>
493       This is implemented in the 11.natgw eventscript. Please see the
494       eventscript for further information.
495     </p></div></div><div class="refsect1" lang="en"><a name="id2476192"></a><h2>ClamAV Daemon</h2><p>
496 CTDB has support to manage the popular anti-virus daemon ClamAV.
497 This support is implemented through the
498 eventscript : /etc/ctdb/events.d/31.clamd.
499 </p><div class="refsect2" lang="en"><a name="id2476203"></a><h3>Configuration</h3><p>
500 Start by configuring CLAMAV normally and test that it works. Once this is
501 done, copy the configuration files over to all the nodes so that all nodes
502 share identical CLAMAV configurations.
503 Once this is done you can proceed with the intructions below to activate
504 CTDB support for CLAMAV.
505 </p><p>
506 First, to activate CLAMAV support in CTDB, edit /etc/sysconfig/ctdb and add the two lines :
507 </p><pre class="screen">
508 CTDB_MANAGES_CLAMD=yes
509 CTDB_CLAMD_SOCKET="/path/to/clamd.socket"
510 </pre><p>
511 Second, activate the eventscript by making it executable:
512 </p><pre class="screen">
513 chmod +x /etc/ctdb/events.d/31.clamd
514 </pre><p>
515 Third, CTDB will now be starting and stopping this service accordingly,
516 so make sure that the system is not configured to start/stop this service
517 automatically.
518 On RedHat systems you can disable the system starting/stopping CLAMAV automatically by running :
519 </p><pre class="screen">
520 chkconfig clamd off
521 </pre><p>
522 </p><p>
523 Once you have restarted CTDBD, use
524 </p><pre class="screen">
525 ctdb scriptstatus
526 </pre><p>
527 and verify that the 31.clamd eventscript is listed and that it was executed successfully.
528 </p></div></div><div class="refsect1" lang="en"><a name="id2476264"></a><h2>SEE ALSO</h2><p>
529       ctdb(1), onnode(1)
530       <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
531     </p></div><div class="refsect1" lang="en"><a name="id2476277"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
532 Copyright (C) Andrew Tridgell 2007<br>
533 Copyright (C) Ronnie sahlberg 2007<br>
534 <br>
535 This program is free software; you can redistribute it and/or modify<br>
536 it under the terms of the GNU General Public License as published by<br>
537 the Free Software Foundation; either version 3 of the License, or (at<br>
538 your option) any later version.<br>
539 <br>
540 This program is distributed in the hope that it will be useful, but<br>
541 WITHOUT ANY WARRANTY; without even the implied warranty of<br>
542 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
543 General Public License for more details.<br>
544 <br>
545 You should have received a copy of the GNU General Public License<br>
546 along with this program; if not, see http://www.gnu.org/licenses/.<br>
547 </p></div></div></div></body></html>