doc/ctdbd.1

   1 .\"     Title: ctdbd
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
   4 .\"      Date: 01/07/2008
   5 .\"    Manual:
   6 .\"    Source:
   7 .\"
   8 .TH "CTDBD" "1" "01/07/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 4
  35 Print some help text to the screen\.
  36 .RE
  37 .PP
  38 \-d \-\-debug=<DEBUGLEVEL>
  39 .RS 4
  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 4
  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 4
  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 4
  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 4
  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 4
  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 4
  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 4
  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 4
  90 Normally ctdb will change its scheduler to run as a real\-time process\. This option is used to change this behaviour and have ctdb run as a normal process\.
  91 .RE
  92 .PP
  93 \-\-public_addresses=<filename>
  94 .RS 4
  95 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\.
  96 .sp
  97 This is usually the file /etc/ctdb/public_addresses
  98 .RE
  99 .PP
 100 \-\-public_interface=<interface>
 101 .RS 4
 102 This option tells ctdb which interface to attach public\-addresses to and also where to attach the single\-public\-ip when used\.
 103 .RE
 104 .PP
 105 \-\-reclock=<filename>
 106 .RS 4
 107 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\.
 108 .RE
 109 .PP
 110 \-\-single\-public\-ip=<address>
 111 .RS 4
 112 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\.
 113 .sp
 114 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\.
 115 .sp
 116 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\.
 117 .RE
 118 .PP
 119 \-\-socket=<filename>
 120 .RS 4
 121 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\.
 122 .sp
 123 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\.
 124 .RE
 125 .PP
 126 \-\-syslog
 127 .RS 4
 128 Send all log messages to syslog instead of to the ctdb logfile\.
 129 .RE
 130 .PP
 131 \-\-torture
 132 .RS 4
 133 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\.
 134 .sp
 135 You do NOT want to use this option unless you are developing and testing new functionality in ctdbd\.
 136 .RE
 137 .PP
 138 \-\-transport=<STRING>
 139 .RS 4
 140 This option specifies which transport to use for ctdbd internode communications\. The default is "tcp"\.
 141 .sp
 142 Suported transports are "tcp" and "infiniband"\.
 143 .RE
 144 .PP
 145 \-\-usage
 146 .RS 4
 147 Print useage information to the screen\.
 148 .RE
 149 .SH "PRIVATE VS PUBLIC ADDRESSES"
 150 .PP
 151 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\.
 152 .SS "Private address"
 153 .PP
 154 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\.
 155 .PP
 156 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\.
 157 .PP
 158 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\.
 159 .PP
 160 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\.
 161
 162       Example /etc/ctdb/nodes for a four node cluster:
 163
 164 .sp
 165 .RS 4
 166 .nf
 167         10\.1\.1\.1
 168         10\.1\.1\.2
 169         10\.1\.1\.3
 170         10\.1\.1\.4
 171
 172 .fi
 173 .RE
 174 .SS "Public address"
 175 .PP
 176 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\.
 177 .PP
 178 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\.
 179 .PP
 180 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\.
 181 .PP
 182 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\.
 183
 184       Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
 185
 186 .sp
 187 .RS 4
 188 .nf
 189         11\.1\.1\.1/24 eth0
 190         11\.1\.1\.2/24 eth0
 191         11\.1\.2\.1/24 eth1
 192         11\.1\.2\.2/24 eth1
 193
 194 .fi
 195 .RE
 196 .PP
 197 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\.
 198
 199         Example: 4 nodes partitioned into two subgroups :
 200
 201 .sp
 202 .RS 4
 203 .nf
 204         Node 0:/etc/ctdb/public_addresses
 205                 10\.1\.1\.1/24 eth0
 206                 10\.1\.1\.2/24 eth0
 207
 208         Node 1:/etc/ctdb/public_addresses
 209                 10\.1\.1\.1/24 eth0
 210                 10\.1\.1\.2/24 eth0
 211
 212         Node 2:/etc/ctdb/public_addresses
 213                 10\.2\.1\.1/24 eth0
 214                 10\.2\.1\.2/24 eth0
 215
 216         Node 3:/etc/ctdb/public_addresses
 217                 10\.2\.1\.1/24 eth0
 218                 10\.2\.1\.2/24 eth0
 219
 220 .fi
 221 .RE
 222 .PP
 223 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\.
 224 .PP
 225 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\.
 226 .SH "NODE STATUS"
 227 .PP
 228 The current status of each node in the cluster can be viewed by the \'ctdb status\' command\.
 229 .PP
 230 There are five possible for a node\.
 231 .PP
 232 OK \- This node is fully functional\.
 233 .PP
 234 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\.
 235 .PP
 236 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\.
 237 .PP
 238 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\.
 239 .PP
 240 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\.
 241 .SH "SEE ALSO"
 242 .PP
 243 ctdb(1), onnode(1)
 244 \fI\%http://ctdb.samba.org/\fR
 245 .SH "COPYRIGHT/LICENSE"
 246 .sp
 247 .RS 4
 248 .nf
 249 Copyright (C) Andrew Tridgell 2007
 250 Copyright (C) Ronnie sahlberg 2007
 251
 252 This program is free software; you can redistribute it and/or modify
 253 it under the terms of the GNU General Public License as published by
 254 the Free Software Foundation; either version 3 of the License, or (at
 255 your option) any later version\.
 256
 257 This program is distributed in the hope that it will be useful, but
 258 WITHOUT ANY WARRANTY; without even the implied warranty of
 259 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\.  See the GNU
 260 General Public License for more details\.
 261
 262 You should have received a copy of the GNU General Public License
 263 along with this program; if not, see http://www\.gnu\.org/licenses/\.
 264 .fi
 265 .RE