improve documentation of --nosetsched
[metze/ctdb/wip.git] / doc / ctdbd.1
1 .\"     Title: ctdbd
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
4 .\"      Date: 01/16/2008
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "CTDBD" "1" "01/16/2008" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 ctdbd \- The CTDB cluster daemon
15 .SH "SYNOPSIS"
16 .HP 6
17 \fBctdbd\fR
18 .HP 6
19 \fBctdbd\fR [\-?\ \-\-help] [\-d\ \-\-debug=<INTEGER>] {\-\-dbdir=<directory>} {\-\-dbdir\-persistent=<directory>} [\-\-event\-script\-dir=<directory>] [\-i\ \-\-interactive] [\-\-listen=<address>] [\-\-logfile=<filename>] {\-\-nlist=<filename>} [\-\-nosetsched] [\-\-public\-addresses=<filename>] [\-\-public\-interface=<interface>] {\-\-reclock=<filename>} [\-\-single\-public\-ip=<address>] [\-\-socket=<filename>] [\-\-syslog] [\-\-torture] [\-\-transport=<STRING>] [\-\-usage]
20 .SH "DESCRIPTION"
21 .PP
22 ctdbd is the main ctdb daemon.
23 .PP
24 ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
25 .PP
26 Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services.
27 .PP
28 ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
29 .PP
30 ctdbd is the main component in clustered Samba that provides a high\-awailability load\-sharing CIFS server cluster.
31 .SH "OPTIONS"
32 .PP
33 \-? \-\-help
34 .RS 3n
35 Print some help text to the screen.
36 .RE
37 .PP
38 \-d \-\-debug=<DEBUGLEVEL>
39 .RS 3n
40 This option sets the debuglevel on the ctdbd daemon which controls what will be written to the logfile. The default is 0 which will only log important events and errors. A larger number will provide additional logging.
41 .RE
42 .PP
43 \-\-dbdir=<directory>
44 .RS 3n
45 This is the directory on local storage where ctdbd keeps the local copy of the TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
46 .sp
47 This directory would usually be /var/ctdb .
48 .RE
49 .PP
50 \-\-dbdir\-persistent=<directory>
51 .RS 3n
52 This is the directory on local storage where ctdbd keeps the local copy of the persistent TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
53 .sp
54 This directory would usually be /etc/ctdb/persistent .
55 .RE
56 .PP
57 \-\-event\-script\-dir=<directory>
58 .RS 3n
59 This option is used to specify the directory where the CTDB event scripts are stored.
60 .sp
61 This will normally be /etc/ctdb/events.d which is part of the ctdb distribution.
62 .RE
63 .PP
64 \-i \-\-interactive
65 .RS 3n
66 By default ctdbd will detach itself from the shell and run in the background as a daemon. This option makes ctdbd to start in interactive mode.
67 .RE
68 .PP
69 \-\-listen=<address>
70 .RS 3n
71 This specifies which ip address ctdb will bind to. By default ctdbd will bind to the first address it finds in the /etc/ctdb/nodes file and which is also present on the local system in which case you do not need to provide this option.
72 .sp
73 This option is only required when you want to run multiple ctdbd daemons/nodes on the same physical host in which case there would be multiple entries in /etc/ctdb/nodes what would match a local interface.
74 .RE
75 .PP
76 \-\-logfile=<filename>
77 .RS 3n
78 This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
79 .RE
80 .PP
81 \-\-nlist=<filename>
82 .RS 3n
83 This file contains a list of the private ip addresses of every node in the cluster. There is one line/ip address for each node. This file must be the same for all nodes in the cluster.
84 .sp
85 This file is usually /etc/ctdb/nodes .
86 .RE
87 .PP
88 \-\-nosetsched
89 .RS 3n
90 This is a ctdbd debugging option. this option is only used when debugging ctdbd.
91 .sp
92 Normally ctdb will change its scheduler to run as a real\-time process. This is the default mode for a normal ctdbd operation to gurarantee that ctdbd always gets the cpu cycles that it needs.
93 .sp
94 This option is used to tell ctdbd to NOT run as a real\-time process and instead run ctdbd as a normal userspace process. This is useful for debugging and when you want to run ctdbd under valgrind or gdb. (You dont want to attach valgrind or gdb to a real\-time process.)
95 .RE
96 .PP
97 \-\-public_addresses=<filename>
98 .RS 3n
99 When used with IP takeover this specifies a file containing the public ip addresses to use on the cluster. This file contains a list of ip addresses netmasks and interfaces. When ctdb is operational it will distribute these public ip addresses evenly across the available nodes.
100 .sp
101 This is usually the file /etc/ctdb/public_addresses
102 .RE
103 .PP
104 \-\-public_interface=<interface>
105 .RS 3n
106 This option tells ctdb which interface to attach public\-addresses to and also where to attach the single\-public\-ip when used.
107 .RE
108 .PP
109 \-\-reclock=<filename>
110 .RS 3n
111 This is the name of the lock file stored of the shared cluster filesystem that ctdbd uses to arbitrate which node has the role of recovery\-master. This file must be stored on shared storage.
112 .RE
113 .PP
114 \-\-single\-public\-ip=<address>
115 .RS 3n
116 This option is used to activate the "ipmux" functionality of ctdb. In this mode, all nodes of the cluster will expose a single ip address from all nodes with all incoming traffic to the cluster being passed through the current recmaster. This functionality is similar to using a load\-balancing switch.
117 .sp
118 All incoming packets are sent to the recmaster which will multiplex the clients across all available nodes and pass the packets on to a different node in the cluster to manage the connection based on the clients ip address. Outgoing packets however are sent directly from the node that was choosen back to the client. Since all incoming packets are sent through the recmaster this will have a throughput and performance impact when used. This impact in performance primarily affects write\-performance while read\-performance should be mainly unaffected. Only use this feature if your environment is mostly\-read (i.e. most traffic is from the nodes back to the clients) or if it is not important to get maximum write\-performance to the cluster.
119 .sp
120 When using a single public ip, you must also specify the public\-interface so that ctdb knows which interface to attach the single public ip to.
121 .RE
122 .PP
123 \-\-socket=<filename>
124 .RS 3n
125 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.
126 .sp
127 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.
128 .RE
129 .PP
130 \-\-syslog
131 .RS 3n
132 Send all log messages to syslog instead of to the ctdb logfile.
133 .RE
134 .PP
135 \-\-torture
136 .RS 3n
137 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.
138 .sp
139 You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
140 .RE
141 .PP
142 \-\-transport=<STRING>
143 .RS 3n
144 This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
145 .sp
146 Suported transports are "tcp" and "infiniband".
147 .RE
148 .PP
149 \-\-usage
150 .RS 3n
151 Print useage information to the screen.
152 .RE
153 .SH "PRIVATE VS PUBLIC ADDRESSES"
154 .PP
155 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.
156 .SS "Private address"
157 .PP
158 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.
159 .PP
160 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.
161 .PP
162 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.
163 .PP
164 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.
165
166       Example /etc/ctdb/nodes for a four node cluster:
167       
168 .sp
169 .RS 3n
170 .nf
171         10.1.1.1
172         10.1.1.2
173         10.1.1.3
174         10.1.1.4
175       
176 .fi
177 .RE
178 .SS "Public address"
179 .PP
180 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.
181 .PP
182 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.
183 .PP
184 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.
185 .PP
186 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.
187
188       Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
189       
190 .sp
191 .RS 3n
192 .nf
193         11.1.1.1/24 eth0
194         11.1.1.2/24 eth0
195         11.1.2.1/24 eth1
196         11.1.2.2/24 eth1
197       
198 .fi
199 .RE
200 .PP
201 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.
202
203         Example: 4 nodes partitioned into two subgroups :
204         
205 .sp
206 .RS 3n
207 .nf
208         Node 0:/etc/ctdb/public_addresses
209                 10.1.1.1/24 eth0
210                 10.1.1.2/24 eth0
211
212         Node 1:/etc/ctdb/public_addresses
213                 10.1.1.1/24 eth0
214                 10.1.1.2/24 eth0
215
216         Node 2:/etc/ctdb/public_addresses
217                 10.2.1.1/24 eth0
218                 10.2.1.2/24 eth0
219
220         Node 3:/etc/ctdb/public_addresses
221                 10.2.1.1/24 eth0
222                 10.2.1.2/24 eth0
223         
224 .fi
225 .RE
226 .PP
227 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.
228 .PP
229 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.
230 .SH "NODE STATUS"
231 .PP
232 The current status of each node in the cluster can be viewed by the 'ctdb status' command.
233 .PP
234 There are five possible for a node.
235 .PP
236 OK \- This node is fully functional.
237 .PP
238 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.
239 .PP
240 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.
241 .PP
242 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.
243 .PP
244 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.
245 .SH "SEE ALSO"
246 .PP
247 ctdb(1), onnode(1)
248 \fI\%http://ctdb.samba.org/\fR
249 .SH "COPYRIGHT/LICENSE"
250 .sp
251 .RS 3n
252 .nf
253 Copyright (C) Andrew Tridgell 2007
254 Copyright (C) Ronnie sahlberg 2007
255
256 This program is free software; you can redistribute it and/or modify
257 it under the terms of the GNU General Public License as published by
258 the Free Software Foundation; either version 3 of the License, or (at
259 your option) any later version.
260
261 This program is distributed in the hope that it will be useful, but
262 WITHOUT ANY WARRANTY; without even the implied warranty of
263 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
264 General Public License for more details.
265
266 You should have received a copy of the GNU General Public License
267 along with this program; if not, see http://www.gnu.org/licenses/.
268 .fi
269 .RE