ctdb/doc/ctdbd.1

   1 '\" t
   2 .\"     Title: ctdbd
   3 .\"    Author:
   4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
   5 .\"      Date: 01/27/2016
   6 .\"    Manual: CTDB - clustered TDB database
   7 .\"    Source: ctdb
   8 .\"  Language: English
   9 .\"
  10 .TH "CTDBD" "1" "01/27/2016" "ctdb" "CTDB \- clustered TDB database"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 ctdbd \- The CTDB cluster daemon
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBctdbd\fR\ 'u
  34 \fBctdbd\fR [\fIOPTION\fR...]
  35 .SH "DESCRIPTION"
  36 .PP
  37 ctdbd is the main CTDB daemon\&.
  38 .PP
  39 Note that ctdbd is not usually invoked directly\&. It is invoked via
  40 \fBctdbd_wrapper\fR(1)
  41 or via the initscript\&.
  42 .PP
  43 See
  44 \fBctdb\fR(7)
  45 for an overview of CTDB\&.
  46 .SH "GENERAL OPTIONS"
  47 .PP
  48 \-d, \-\-debug=\fIDEBUGLEVEL\fR
  49 .RS 4
  50 This option sets the debug level to DEBUGLEVEL, which controls what will be written by the logging subsystem\&. The default is 2\&.
  51 .sp
  52 See the
  53 DEBUG LEVELS
  54 section in
  55 \fBctdb\fR(7)
  56 for more information\&.
  57 .RE
  58 .PP
  59 \-\-dbdir=\fIDIRECTORY\fR
  60 .RS 4
  61 DIRECTORY on local storage where ctdbd keeps a local copy of TDB databases\&. This directory is local for each node and should not be stored on the shared cluster filesystem\&.
  62 .sp
  63 Defaults to
  64 /usr/local/var/lib/ctdb\&.
  65 .RE
  66 .PP
  67 \-\-dbdir\-persistent=\fIDIRECTORY\fR
  68 .RS 4
  69 DIRECTORY on local storage where ctdbd keeps a local copy of persistent TDB databases\&. This directory is local for each node and should not be stored on the shared cluster filesystem\&.
  70 .sp
  71 Defaults to
  72 /usr/local/var/lib/ctdb/persistent\&.
  73 .RE
  74 .PP
  75 \-\-dbdir\-state=\fIDIRECTORY\fR
  76 .RS 4
  77 DIRECTORY on local storage where ctdbd keep internal state TDB files\&. This directory is local for each node and should not be stored on the shared cluster filesystem\&.
  78 .sp
  79 Defaults to
  80 /usr/local/var/lib/ctdb/state\&.
  81 .RE
  82 .PP
  83 \-\-event\-script\-dir=\fIDIRECTORY\fR
  84 .RS 4
  85 DIRECTORY where the CTDB event scripts are stored\&. See the
  86 EVENT SCRIPTS
  87 section in
  88 \fBctdb\fR(7)
  89 for more information\&.
  90 .sp
  91 Default is
  92 \fBCTDB_BASE\fR/events\&.d, so usually
  93 /usr/local/etc/ctdb/events\&.d, which is part of the CTDB installation\&.
  94 .RE
  95 .PP
  96 \-\-listen=\fIIPADDR\fR
  97 .RS 4
  98 IPADDR is the private IP address that ctdbd will bind to\&.
  99 .sp
 100 By default ctdbd will select the first address from the nodes list that in can bind to\&. See also
 101 \-\-nlist\&.
 102 .sp
 103 This option is only required when automatic address detection can not be used\&. This can be the case when running multiple ctdbd daemons/nodes on the same physical host (usually for testing), using InfiniBand for the private network or on Linux when sysctl net\&.ipv4\&.ip_nonlocal_bind=1\&.
 104 .RE
 105 .PP
 106 \-\-logging=\fISTRING\fR
 107 .RS 4
 108 STRING specifies where ctdbd will write its log\&. The default is file:/usr/local/var/log/log\&.ctdb\&.
 109 .sp
 110 Valid values are:
 111 .PP
 112 file:\fIFILENAME\fR
 113 .RS 4
 114 FILENAME where ctdbd will write its log\&. This is usually
 115 /usr/local/var/log/log\&.ctdb\&.
 116 .RE
 117 .PP
 118 syslog[:\fIMETHOD\fR]
 119 .RS 4
 120 CTDB will log to syslog\&. By default this will use the syslog(3) API\&.
 121 .sp
 122 Under heavy loads syslog(3) can block if the syslog daemon processes messages too slowly\&. This can cause CTDB to block when logging\&.
 123 .sp
 124 If METHOD is specified then it specifies an extension that causes logging to be done in a non\-blocking mode\&. Note that
 125 \fIthis may cause messages to be dropped\fR\&. METHOD must be one of:
 126 .PP
 127 nonblocking
 128 .RS 4
 129 CTDB will log to syslog via
 130 /dev/log
 131 in non\-blocking mode\&.
 132 .RE
 133 .PP
 134 udp
 135 .RS 4
 136 CTDB will log to syslog via UDP to localhost:514\&. The syslog daemon must be configured to listen on (at least) localhost:514\&. Most syslog daemons will log the messages with hostname "localhost" \- this is a limitation of the implementation, for compatibility with more syslog daemons\&.
 137 .RE
 138 .PP
 139 udp\-rfc5424
 140 .RS 4
 141 As with "udp" but messages are sent in RFC5424 format\&. This method will log the correct hostname but is not as widely implemented in syslog daemons\&.
 142 .RE
 143 .RE
 144 .RE
 145 .PP
 146 \-\-lvs
 147 .RS 4
 148 This option is used to activate the LVS capability on a CTDB node\&. Please see the
 149 LVS
 150 section in
 151 \fBctdb\fR(7)
 152 for more information\&.
 153 .RE
 154 .PP
 155 \-\-max\-persistent\-check\-errors=\fINUM\fR
 156 .RS 4
 157 NUM specifies the maximum number of health check failures allowed for persistent databases during startup\&.
 158 .sp
 159 The default value is 0\&. Setting this to non\-zero allows a node with unhealthy persistent databases to startup and join the cluster as long as there is another node with healthy persistent databases\&.
 160 .RE
 161 .PP
 162 \-\-nlist=\fIFILENAME\fR
 163 .RS 4
 164 FILENAME containing a list of the private IP addresses, one per line, for each node in the cluster\&. This file
 165 \fImust be the same on each node\fR
 166 in the cluster\&.
 167 .sp
 168 Default is
 169 \fBCTDB_BASE\fR/nodes, so usually
 170 /usr/local/etc/ctdb/nodes\&.
 171 .RE
 172 .PP
 173 \-\-no\-lmaster
 174 .RS 4
 175 This argument specifies that this node can NOT become an lmaster for records in the database\&. This means that it will never show up in the vnnmap\&. This feature is primarily used for making a cluster span across a WAN link and use CTDB as a WAN\-accelerator\&.
 176 .sp
 177 Please see the
 178 REMOTE CLUSTER NODES
 179 section in
 180 \fBctdb\fR(7)
 181 for more information\&.
 182 .RE
 183 .PP
 184 \-\-no\-recmaster
 185 .RS 4
 186 This argument specifies that this node can NOT become a recmaster for the database\&. This feature is primarily used for making a cluster span across a WAN link and use CTDB as a WAN\-accelerator\&.
 187 .sp
 188 Please see the
 189 REMOTE CLUSTER NODES
 190 section in
 191 \fBctdb\fR(7)
 192 for more information\&.
 193 .RE
 194 .PP
 195 \-\-notification\-script=\fIFILENAME\fR
 196 .RS 4
 197 FILENAME specifying a script to be invoked by ctdbd when certain state changes occur\&.
 198 .sp
 199 This file is usually
 200 /usr/local/etc/ctdb/notify\&.sh\&.
 201 .sp
 202 Please see the
 203 NOTIFICATION SCRIPT
 204 section in
 205 \fBctdb\fR(7)
 206 for more information\&.
 207 .RE
 208 .PP
 209 \-\-pidfile=\fIFILENAME\fR
 210 .RS 4
 211 FILENAME for file containing process ID of main CTDB daemon\&. This file is automatically created and removed by CTDB\&.
 212 .sp
 213 The default is to not create a PID file\&.
 214 .RE
 215 .PP
 216 \-\-public_addresses=\fIFILENAME\fR
 217 .RS 4
 218 FILENAME specifying a file containing the public IP addresses to use on the cluster when CTDB should use IP takeover\&. This file contains a list of IP addresses, netmasks and interfaces\&. CTDB will distribute these public IP addresses appropriately across the available nodes\&.
 219 .sp
 220 The IP addresses specified in this file can differ across nodes\&.
 221 .sp
 222 This is usually the file
 223 /usr/local/etc/ctdb/public_addresses
 224 .RE
 225 .PP
 226 \-\-public\-interface=\fIINTERFACE\fR
 227 .RS 4
 228 INTERFACE on which to attach public IP addresses or on which to attach the single\-public\-ip when used\&.
 229 .sp
 230 When using public IP addresses, this is only required if interfaces are not explicitly specified in the public addresses file\&.
 231 .RE
 232 .PP
 233 \-\-reclock=\fIFILE\fR
 234 .RS 4
 235 FILE is the name of the recovery lock file, stored in
 236 \fIshared storage\fR, that CTDB uses to prevent split brains\&.
 237 .sp
 238 For information about the recovery lock please see the
 239 RECOVERY LOCK
 240 section in
 241 \fBctdb\fR(7)\&.
 242 .RE
 243 .PP
 244 \-\-single\-public\-ip=\fIIPADDR\fR
 245 .RS 4
 246 IPADDR specifies the single IP that CTDB will use in conjunction with LVS\&.
 247 .sp
 248 Please see the
 249 LVS
 250 section in
 251 \fBctdb\fR(7)
 252 for more information\&.
 253 .RE
 254 .PP
 255 \-\-start\-as\-disabled
 256 .RS 4
 257 This makes ctdbd start in the DISABLED state\&.
 258 .sp
 259 To allow the node to host public IP addresses and services, it must be manually enabled using the
 260 \fBctdb enable\fR
 261 command\&.
 262 .sp
 263 Please see the
 264 NODE STATES
 265 section in
 266 \fBctdb\fR(7)
 267 for more information about the DISABLED state\&.
 268 .RE
 269 .PP
 270 \-\-start\-as\-stopped
 271 .RS 4
 272 This makes ctdbd start in the STOPPED state\&.
 273 .sp
 274 To allow the node to take part in the cluster it must be manually continued with the the
 275 \fBctdb enable\fR
 276 command\&.
 277 .sp
 278 Please see the
 279 NODE STATES
 280 section in
 281 \fBctdb\fR(7)
 282 for more information about the STOPPED state\&.
 283 .RE
 284 .PP
 285 \-\-transport=tcp|infiniband
 286 .RS 4
 287 This option specifies which transport to use for ctdbd internode communications\&. The default is "tcp"\&.
 288 .sp
 289 The "infiniband" support is not regularly tested\&.
 290 .RE
 291 .PP
 292 \-?, \-\-help
 293 .RS 4
 294 Display a summary of options\&.
 295 .RE
 296 .SH "DEBUGGING OPTIONS"
 297 .PP
 298 \-i, \-\-interactive
 299 .RS 4
 300 Enable interactive mode\&. This will make ctdbd run in the foreground and not detach from the terminal\&. By default ctdbd will detach itself and run in the background as a daemon\&.
 301 .RE
 302 .PP
 303 \-\-nopublicipcheck
 304 .RS 4
 305 This option is used when testing with multiple local daemons on a single machine\&. It disables checks related to public IP addresses\&.
 306 .RE
 307 .PP
 308 \-\-nosetsched
 309 .RS 4
 310 This is a debugging option\&. This option is only used when debugging ctdbd\&.
 311 .sp
 312 Normally ctdbd 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\&.
 313 .sp
 314 This option is used to tell ctdbd to
 315 \fInot\fR
 316 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 don\*(Aqt want to attach valgrind or gdb to a real\-time process\&.)
 317 .RE
 318 .PP
 319 \-\-socket=\fIFILENAME\fR
 320 .RS 4
 321 FILENAME specifies the name of the Unix domain socket that ctdbd will create\&. This socket is used by local clients to communicate with ctdbd\&.
 322 .sp
 323 The default is
 324 /usr/local/var/run/ctdb/ctdbd\&.socket\&. You only need to use this option if you plan to run multiple ctdbd daemons on the same physical host, usually for testing\&.
 325 .RE
 326 .PP
 327 \-\-script\-log\-level=\fIDEBUGLEVEL\fR
 328 .RS 4
 329 This option sets the debug level of event script output to DEBUGLEVEL\&. The default is ERR (0)\&.
 330 .sp
 331 See the
 332 DEBUG LEVELS
 333 section in
 334 \fBctdb\fR(7)
 335 for more information\&.
 336 .RE
 337 .PP
 338 \-\-sloppy\-start
 339 .RS 4
 340 This is debugging option\&. This speeds up the initial recovery during startup at the expense of some consistency checking\&.
 341 \fIDon\*(Aqt use this option in production\fR\&.
 342 .RE
 343 .PP
 344 \-\-torture
 345 .RS 4
 346 This option is only used for development and testing of CTDB\&. It adds artificial errors and failures to the common codepaths in ctdbd to verify that ctdbd can recover correctly from failures\&.
 347 .sp
 348 \fIDo not use this option\fR
 349 unless you are developing and testing new functionality in CTDB\&.
 350 .RE
 351 .PP
 352 \-\-valgrinding
 353 .RS 4
 354 This is a debugging option\&. This option is only used when debugging ctdbd\&. This enables additional debugging capabilities and implies \-\-nosetsched\&.
 355 .RE
 356 .SH "SEE ALSO"
 357 .PP
 358 \fBctdb\fR(1),
 359 \fBctdbd_wrapper\fR(1),
 360 \fBonnode\fR(1),
 361 \fBctdb\fR(7),
 362 \fBctdb-tunables\fR(7),
 363 \m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
 364 .SH "AUTHOR"
 365 .br
 366 .PP
 367 This documentation was written by Ronnie Sahlberg, Amitay Isaacs, Martin Schwenke
 368 .SH "COPYRIGHT"
 369 .br
 370 Copyright \(co 2007 Andrew Tridgell, Ronnie Sahlberg
 371 .br
 372 .PP
 373 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version\&.
 374 .PP
 375 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
 376 .PP
 377 You should have received a copy of the GNU General Public License along with this program; if not, see
 378 \m[blue]\fB\%http://www.gnu.org/licenses\fR\m[]\&.
 379 .sp