source4/cluster/ctdb/doc/ctdbd.1

   1 .\"     Title: ctdbd
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
   4 .\"      Date: 07/10/2007
   5 .\"    Manual:
   6 .\"    Source:
   7 .\"
   8 .TH "CTDBD" "1" "07/10/2007" "" ""
   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 {\-\-reclock=<filename>} {\-\-nlist=<filename>} {\-\-dbdir=<directory>} [\-?\ \-\-help] [\-\-usage] [\-i\ \-\-interactive] [\-\-public\-addresses=<filename>] [\-\-public\-interface=<interface>] [\-\-event\-script=<filename>] [\-\-logfile=<filename>] [\-\-listen=<address>] [\-\-transport=<STRING>] [\-\-socket=<filename>] [\-d\ \-\-debug=<INTEGER>] [\-\-torture]
  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 \-\-usage
  39 .RS 4
  40 Print useage information to the screen.
  41 .RE
  42 .PP
  43 \-\-reclock=<filename>
  44 .RS 4
  45 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.
  46 .RE
  47 .PP
  48 \-\-nlist=<filename>
  49 .RS 4
  50 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.
  51 .sp
  52 This file is usually /etc/ctdb/nodes .
  53 .RE
  54 .PP
  55 \-\-dbdir=<directory>
  56 .RS 4
  57 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.
  58 .sp
  59 This directory would usually be /var/ctdb .
  60 .RE
  61 .PP
  62 \-i \-\-interactive
  63 .RS 4
  64 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.
  65 .RE
  66 .PP
  67 \-\-public_addresses=<filename>
  68 .RS 4
  69 When used with IP takeover this specifies a file containing the public ip addresses to use on the cluster. This file contains one entry for each node in the cluster.
  70 .sp
  71 This is usually the file /etc/ctdb/public_addresses
  72 .RE
  73 .PP
  74 \-\-public\-interface=<interface>
  75 .RS 4
  76 When used with IP takeover this option specifies which physical interface should be used to attach the public addresses to.
  77 .RE
  78 .PP
  79 \-\-event\-script=<filename>
  80 .RS 4
  81 This option is used to specify which events script that ctdbd will use to manage services when the cluster configuration changes.
  82 .sp
  83 This will normally be /etc/ctdb/events which is part of the ctdb distribution.
  84 .RE
  85 .PP
  86 \-\-logfile=<filename>
  87 .RS 4
  88 This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
  89 .RE
  90 .PP
  91 \-\-listen=<address>
  92 .RS 4
  93 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.
  94 .sp
  95 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.
  96 .RE
  97 .PP
  98 \-\-transport=<STRING>
  99 .RS 4
 100 This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
 101 .sp
 102 Suported transports are "tcp" and "infiniband".
 103 .RE
 104 .PP
 105 \-\-socket=<filename>
 106 .RS 4
 107 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.
 108 .sp
 109 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.
 110 .RE
 111 .PP
 112 \-d \-\-debug=<DEBUGLEVEL>
 113 .RS 4
 114 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.
 115 .RE
 116 .PP
 117 \-\-torture
 118 .RS 4
 119 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.
 120 .sp
 121 You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
 122 .RE
 123 .SH "PRIVATE VS PUBLIC ADDRESSES"
 124 .PP
 125 When used for ip takeover in a HA environment, each node in a ctdb cluster has two ip addresses assigned to it. One private and one public.
 126 .SS "Private address"
 127 .PP
 128 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.
 129 .PP
 130 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.
 131 .PP
 132 Each node is assigned an internal node number which corresponds to which line in the nodes file that has the local private address of the node.
 133 .PP
 134 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.
 135
 136       Example /etc/ctdb/nodes for a four node cluster:
 137
 138 .sp
 139 .RS 4
 140 .nf
 141         10.1.1.1
 142         10.1.1.2
 143         10.1.1.3
 144         10.1.1.4
 145
 146 .fi
 147 .RE
 148 .SS "Public address"
 149 .PP
 150 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. You should NOT have this address configured to an interface in linux. Let ctdbd manage these addresses.
 151 .PP
 152 The ctdb cluster will assign/reassign these public addresses across the available 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.
 153 .PP
 154 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.
 155 .PP
 156 By default, each node will when operational always serve its primary public address which is the corresponding line for that node number in the public addresses file. I.e. as long as node X is available and fully oprational it will always be the node that serves the corresponding public address.
 157 .PP
 158 The list of public addresses also contain the netmask for that address. the reason for this is because ctdbd needs to know which mask to use when it adds/removes the address from a physical node. This netmask is also used by ctdbd when making decisions on which node should take over a public ip address for a failed node. A node will only be allowed to take over a public address from a different node IFF that public address resides in the same subnet as the primary public address for that node.
 159
 160       Example /etc/ctdb/public_addresses for a four node cluster:
 161
 162 .sp
 163 .RS 4
 164 .nf
 165         11.1.1.1/24
 166         11.1.1.2/24
 167         11.1.2.1/24
 168         11.1.2.2/24
 169
 170 .fi
 171 .RE
 172 .PP
 173 In this example, if node 3 fails, its public address can be taken over by node 2 since node 2 is on the same subnet as 3 but not by node 0 or node 1 since node 0 and 1 are both on a different subnet from node 3.
 174 .SH "NODE STATUS"
 175 .PP
 176 The current status of each node in the cluster can be viewed by the 'ctdb status' command.
 177 .PP
 178 There are five possible for a node.
 179 .PP
 180 OK \- This node is fully functional.
 181 .PP
 182 DISCONNECTED \- This node could not be connected through the network and is currently not parcipitating 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.
 183 .PP
 184 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.
 185 .PP
 186 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.
 187 .PP
 188 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.
 189 .SH "SEE ALSO"
 190 .PP
 191 ctdb(1), onnode(1)
 192 \fI\%http://ctdb.samba.org/\fR
 193 .SH "COPYRIGHT/LICENSE"
 194 .sp
 195 .RS 4
 196 .nf
 197 Copyright (C) Andrew Tridgell 2007
 198 Copyright (C) Ronnie sahlberg 2007
 199
 200 This program is free software; you can redistribute it and/or modify
 201 it under the terms of the GNU General Public License as published by
 202 the Free Software Foundation; either version 3 of the License, or (at
 203 your option) any later version.
 204
 205 This program is distributed in the hope that it will be useful, but
 206 WITHOUT ANY WARRANTY; without even the implied warranty of
 207 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 208 General Public License for more details.
 209
 210 You should have received a copy of the GNU General Public License
 211 along with this program; if not, see http://www.gnu.org/licenses/.
 212 .fi
 213 .RE