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