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: 12/10/2015
   6 .\"    Manual: CTDB - clustered TDB database
   7 .\"    Source: ctdb
   8 .\"  Language: English
   9 .\"
  10 .TH "CTDBD" "1" "12/10/2015" "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 This directory would usually be
  64 /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 This directory would usually be
  72 /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 This directory would usually be
  80 /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 /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:/var/log/log\&.ctdb
 109 or similar \- the prefix may differ depending on how CTDB was built\&.
 110 .sp
 111 Valid values are:
 112 .PP
 113 file:\fIFILENAME\fR
 114 .RS 4
 115 FILENAME where ctdbd will write its log\&. This is usually
 116 /var/log/log\&.ctdb\&.
 117 .RE
 118 .PP
 119 syslog[:\fIMETHOD\fR]
 120 .RS 4
 121 CTDB will log to syslog\&. By default this will use the syslog(3) API\&.
 122 .sp
 123 Under heavy loads syslog(3) can block if the syslog daemon processes messages too slowly\&. This can cause CTDB to block when logging\&.
 124 .sp
 125 If METHOD is specified then it specifies an extension that causes logging to be done in a non\-blocking mode\&. Note that
 126 \fIthis may cause messages to be dropped\fR\&. METHOD must be one of:
 127 .PP
 128 nonblocking
 129 .RS 4
 130 CTDB will log to syslog via
 131 /dev/log
 132 in non\-blocking mode\&.
 133 .RE
 134 .PP
 135 udp
 136 .RS 4
 137 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\&.
 138 .RE
 139 .PP
 140 udp\-rfc5424
 141 .RS 4
 142 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\&.
 143 .RE
 144 .RE
 145 .RE
 146 .PP
 147 \-\-lvs
 148 .RS 4
 149 This option is used to activate the LVS capability on a CTDB node\&. Please see the
 150 LVS
 151 section in
 152 \fBctdb\fR(7)
 153 for more information\&.
 154 .RE
 155 .PP
 156 \-\-max\-persistent\-check\-errors=\fINUM\fR
 157 .RS 4
 158 NUM specifies the maximum number of health check failures allowed for persistent databases during startup\&.
 159 .sp
 160 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\&.
 161 .RE
 162 .PP
 163 \-\-nlist=\fIFILENAME\fR
 164 .RS 4
 165 FILENAME containing a list of the private IP addresses, one per line, for each node in the cluster\&. This file
 166 \fImust be the same on each node\fR
 167 in the cluster\&.
 168 .sp
 169 Default is
 170 \fBCTDB_BASE\fR/nodes, so usually
 171 /etc/ctdb/nodes\&.
 172 .RE
 173 .PP
 174 \-\-no\-lmaster
 175 .RS 4
 176 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\&.
 177 .sp
 178 Please see the
 179 REMOTE CLUSTER NODES
 180 section in
 181 \fBctdb\fR(7)
 182 for more information\&.
 183 .RE
 184 .PP
 185 \-\-no\-recmaster
 186 .RS 4
 187 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\&.
 188 .sp
 189 Please see the
 190 REMOTE CLUSTER NODES
 191 section in
 192 \fBctdb\fR(7)
 193 for more information\&.
 194 .RE
 195 .PP
 196 \-\-notification\-script=\fIFILENAME\fR
 197 .RS 4
 198 FILENAME specifying a script to be invoked by ctdbd when certain state changes occur\&.
 199 .sp
 200 This file is usually
 201 /etc/ctdb/notify\&.sh\&.
 202 .sp
 203 Please see the
 204 NOTIFICATION SCRIPT
 205 section in
 206 \fBctdb\fR(7)
 207 for more information\&.
 208 .RE
 209 .PP
 210 \-\-pidfile=\fIFILENAME\fR
 211 .RS 4
 212 FILENAME for file containing process ID of main CTDB daemon\&. This file is automatically created and removed by CTDB\&.
 213 .sp
 214 The default is to not create a PID file\&.
 215 .RE
 216 .PP
 217 \-\-public_addresses=\fIFILENAME\fR
 218 .RS 4
 219 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\&.
 220 .sp
 221 The IP addresses specified in this file can differ across nodes\&.
 222 .sp
 223 This is usually the file
 224 /etc/ctdb/public_addresses
 225 .RE
 226 .PP
 227 \-\-public\-interface=\fIINTERFACE\fR
 228 .RS 4
 229 INTERFACE on which to attach public IP addresses or on which to attach the single\-public\-ip when used\&.
 230 .sp
 231 When using public IP addresses, this is only required if interfaces are not explicitly specified in the public addresses file\&.
 232 .RE
 233 .PP
 234 \-\-reclock=\fIFILE\fR
 235 .RS 4
 236 FILE is the name of the recovery lock file, stored in
 237 \fIshared storage\fR, that CTDB uses to prevent split brains\&.
 238 .sp
 239 For information about the recovery lock please see the
 240 RECOVERY LOCK
 241 section in
 242 \fBctdb\fR(7)\&.
 243 .RE
 244 .PP
 245 \-\-single\-public\-ip=\fIIPADDR\fR
 246 .RS 4
 247 IPADDR specifies the single IP that CTDB will use in conjuction with LVS\&.
 248 .sp
 249 Please see the
 250 LVS
 251 section in
 252 \fBctdb\fR(7)
 253 for more information\&.
 254 .RE
 255 .PP
 256 \-\-start\-as\-disabled
 257 .RS 4
 258 This makes ctdbd start in the DISABLED state\&.
 259 .sp
 260 To allow the node to host public IP addresses and services, it must be manually enabled using the
 261 \fBctdb enable\fR
 262 command\&.
 263 .sp
 264 Please see the
 265 NODE STATES
 266 section in
 267 \fBctdb\fR(7)
 268 for more information about the DISABLED state\&.
 269 .RE
 270 .PP
 271 \-\-start\-as\-stopped
 272 .RS 4
 273 This makes ctdbd start in the STOPPED state\&.
 274 .sp
 275 To allow the node to take part in the cluster it must be manually continued with the the
 276 \fBctdb enable\fR
 277 command\&.
 278 .sp
 279 Please see the
 280 NODE STATES
 281 section in
 282 \fBctdb\fR(7)
 283 for more information about the STOPPED state\&.
 284 .RE
 285 .PP
 286 \-\-syslog
 287 .RS 4
 288 Send log messages to syslog instead of the CTDB logfile\&. This option overrides \-\-logfile\&. The default is to log to a file\&.
 289 .RE
 290 .PP
 291 \-\-transport=tcp|infiniband
 292 .RS 4
 293 This option specifies which transport to use for ctdbd internode communications\&. The default is "tcp"\&.
 294 .sp
 295 The "infiniband" support is not regularly tested\&.
 296 .RE
 297 .PP
 298 \-?, \-\-help
 299 .RS 4
 300 Display a summary of options\&.
 301 .RE
 302 .SH "DEBUGGING OPTIONS"
 303 .PP
 304 \-i, \-\-interactive
 305 .RS 4
 306 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\&.
 307 .RE
 308 .PP
 309 \-\-nopublicipcheck
 310 .RS 4
 311 This option is used when testing with multiple local daemons on a single machine\&. It disables checks related to public IP addresses\&.
 312 .RE
 313 .PP
 314 \-\-nosetsched
 315 .RS 4
 316 This is a debugging option\&. This option is only used when debugging ctdbd\&.
 317 .sp
 318 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\&.
 319 .sp
 320 This option is used to tell ctdbd to
 321 \fInot\fR
 322 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\&.)
 323 .RE
 324 .PP
 325 \-\-socket=\fIFILENAME\fR
 326 .RS 4
 327 FILENAME specifies the name of the Unix domain socket that ctdbd will create\&. This socket is used by local clients to communicate with ctdbd\&.
 328 .sp
 329 The default is
 330 /tmp/ctdb\&.socket
 331 \&. You only need to use this option if you plan to run multiple ctdbd daemons on the same physical host, usually for testing\&.
 332 .RE
 333 .PP
 334 \-\-script\-log\-level=\fIDEBUGLEVEL\fR
 335 .RS 4
 336 This option sets the debug level of event script output to DEBUGLEVEL\&. The default is ERR (0)\&.
 337 .sp
 338 See the
 339 DEBUG LEVELS
 340 section in
 341 \fBctdb\fR(7)
 342 for more information\&.
 343 .RE
 344 .PP
 345 \-\-sloppy\-start
 346 .RS 4
 347 This is debugging option\&. This speeds up the initial recovery during startup at the expense of some consistency checking\&.
 348 \fIDon\*(Aqt use this option in production\fR\&.
 349 .RE
 350 .PP
 351 \-\-torture
 352 .RS 4
 353 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\&.
 354 .sp
 355 \fIDo not use this option\fR
 356 unless you are developing and testing new functionality in CTDB\&.
 357 .RE
 358 .PP
 359 \-\-valgrinding
 360 .RS 4
 361 This is a debugging option\&. This option is only used when debugging ctdbd\&. This enables additional debugging capabilities and implies \-\-nosetsched\&.
 362 .RE
 363 .SH "SEE ALSO"
 364 .PP
 365 \fBctdb\fR(1),
 366 \fBctdbd_wrapper\fR(1),
 367 \fBonnode\fR(1),
 368 \fBctdb\fR(7),
 369 \fBctdb-tunables\fR(7),
 370 \m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
 371 .SH "AUTHOR"
 372 .br
 373 .PP
 374 This documentation was written by Ronnie Sahlberg, Amitay Isaacs, Martin Schwenke
 375 .SH "COPYRIGHT"
 376 .br
 377 Copyright \(co 2007 Andrew Tridgell, Ronnie Sahlberg
 378 .br
 379 .PP
 380 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\&.
 381 .PP
 382 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\&.
 383 .PP
 384 You should have received a copy of the GNU General Public License along with this program; if not, see
 385 \m[blue]\fB\%http://www.gnu.org/licenses\fR\m[]\&.
 386 .sp