1CTDB.CONF(5)             CTDB - clustered TDB database            CTDB.CONF(5)
2
3
4

NAME

6       ctdb.conf - CTDB configuration file
7

DESCRIPTION

9       This file contains CTDB configuration options that affect the operation
10       of CTDB daemons and command-line tools. The default location of this
11       file is /etc/ctdb/ctdb.conf.
12
13       Note that this is a Samba-style configuration file, so it has a very
14       different syntax to previous CTDB configuration files.
15
16       For event script options please see ctdb-script.options(5).
17
18       Configuration options are grouped into several sections below. There
19       are only a few options in each section, allowing them to be ordered
20       (approximately) in decreasing order of importance.
21

LOGGING CONFIGURATION

23       Options in this section control CTDB's logging. They are valid within
24       the logging section of file, indicated by [logging].
25
26       log level = LOGLEVEL
27           LOGLEVEL is a string that controls the verbosity of ctdbd's
28           logging. See the LOG LEVELS section in ctdb(7) for more details.
29
30           Default: NOTICE
31
32       location = STRING
33           STRING specifies where ctdbd will write its log.
34
35           Valid values are:
36
37           file:FILENAME
38               FILENAME where ctdbd will write its log. This is usually
39               /var/log/log.ctdb.
40
41           syslog[:METHOD]
42               CTDB will log to syslog. By default this will use the syslog(3)
43               API.
44
45               If METHOD is specified then it specifies an extension that
46               causes logging to be done in a non-blocking fashion. This can
47               be useful under heavy loads that might cause the syslog daemon
48               to dequeue messages too slowly, which would otherwise cause
49               CTDB to block when logging. METHOD must be one of:
50
51               nonblocking
52                   CTDB will log to syslog via /dev/log in non-blocking mode.
53
54               udp
55                   CTDB will log to syslog via UDP to localhost:514. The
56                   syslog daemon must be configured to listen on (at least)
57                   localhost:514. Most implementations will log the messages
58                   against hostname "localhost" - this is a limit of the
59                   implementation for compatibility with more syslog daemon
60                   implementations.
61
62               udp-rfc5424
63                   As with "udp" but messages are sent in RFC5424 format. This
64                   method will log the correct hostname but is not as widely
65                   implemented in syslog daemons.
66
67           Default: file:/var/log/log.ctdb
68

CLUSTER CONFIGURATION

70       Options in this section affect the CTDB cluster setup. They are valid
71       within the cluster section of file, indicated by [cluster].
72
73       recovery lock = LOCK
74           LOCK specifies the cluster-wide mutex used to detect and prevent a
75           partitioned cluster (or "split brain").
76
77           For information about the recovery lock please see the RECOVERY
78           LOCK section in ctdb(7).
79
80           Default: NONE. However, uses of a recovery lock is strongly
81           recommended.
82
83       node address = IPADDR
84           IPADDR is the private IP address that ctdbd will bind to.
85
86           This option is only required when automatic address detection can
87           not be used. This can be the case when running multiple ctdbd
88           daemons/nodes on the same physical host (usually for testing),
89           using InfiniBand for the private network or on Linux when sysctl
90           net.ipv4.ip_nonlocal_bind=1.
91
92           Default: CTDB selects the first address from the nodes list that it
93           can bind to. See also the PRIVATE ADDRESS section in ctdb(7).
94
95       transport = tcp|ib
96           This option specifies which transport to use for ctdbd internode
97           communications on the private network.
98
99           ib means InfiniBand. The InfiniBand support is not regularly
100           tested. If it is known to be broken then it may be disabled so that
101           a value of ib is considered invalid.
102
103           Default: tcp
104

DATABASE CONFIGURATION

106       Options in this section affect the CTDB database setup. They are valid
107       within the database section of file, indicated by [database].
108
109       volatile database directory = DIRECTORY
110           DIRECTORY on local storage where CTDB keeps a local copy of
111           volatile TDB databases. This directory is local for each node and
112           should not be stored on the shared cluster filesystem.
113
114           Mounting a tmpfs (or similar memory filesystem) on this directory
115           can provide a significant performance improvement when there is I/O
116           contention on the local disk.
117
118           Default: /var/lib/ctdb/volatile
119
120       persistent database directory=DIRECTORY
121           DIRECTORY on local storage where CTDB keeps a local copy of
122           persistent TDB databases. This directory is local for each node and
123           should not be stored on the shared cluster filesystem.
124
125           Default: /var/lib/ctdb/persistent
126
127       state database directory = DIRECTORY
128           DIRECTORY on local storage where CTDB keeps a local copy of
129           internal state TDB databases. This directory is local for each node
130           and should not be stored on the shared cluster filesystem.
131
132           Default: /var/lib/ctdb/state
133
134       tdb mutexes = true|false
135           This parameter enables TDB_MUTEX_LOCKING feature on volatile
136           databases if the robust mutexes are supported. This optimizes the
137           record locking using robust mutexes and is much more efficient that
138           using posix locks.
139
140           If robust mutexes are unreliable on the platform being used then
141           they can be disabled by setting this to false.
142
143       lock debug script = FILENAME
144           FILENAME is a script used by CTDB's database locking code to
145           attempt to provide debugging information when CTDB is unable to
146           lock an entire database or a record.
147
148           This script should be a bare filename relative to the CTDB
149           configuration directory (/etc/ctdb/). Any directory prefix is
150           ignored and the path is calculated relative to this directory.
151
152           CTDB provides a lock debugging script and installs it as
153           /etc/ctdb/debug_locks.sh.
154
155           Default: NONE
156

EVENT HANDLING CONFIGURATION

158       Options in this section affect CTDB event handling. They are valid
159       within the event section of file, indicated by [event].
160
161       debug script = FILENAME
162           FILENAME is a script used by CTDB's event handling code to attempt
163           to provide debugging information when an event times out.
164
165           This script should be a bare filename relative to the CTDB
166           configuration directory (/etc/ctdb/). Any directory prefix is
167           ignored and the path is calculated relative to this directory.
168
169           CTDB provides a script for debugging timed out event scripts and
170           installs it as /etc/ctdb/debug-hung-script.sh.
171
172           Default: NONE
173

FAILOVER CONFIGURATION

175       Options in this section affect CTDB failover. They are valid within the
176       failover section of file, indicated by [failover].
177
178       disabled = true|false
179           If set to true then public IP failover is disabled.
180
181           Default: false
182

LEGACY CONFIGURATION

184       Options in this section affect legacy CTDB setup. They are valid within
185       the legacy section of file, indicated by [legacy].
186
187       ctdb start as stopped = true|false
188           If set to true CTDB starts in the STOPPED state.
189
190           To allow the node to take part in the cluster it must be manually
191           continued with the ctdb continue command.
192
193           Please see the NODE STATES section in ctdb(7) for more information
194           about the STOPPED state.
195
196           Default: false
197
198       start as disabled = true|false
199           If set to true CTDB starts in the DISABLED state.
200
201           To allow the node to host public IP addresses and services, it must
202           be manually enabled using the ctdb enable command.
203
204           Please see the NODE STATES section in ctdb(7) for more information
205           about the DISABLED state.
206
207           Default: false
208
209       realtime scheduling = true|false
210           Usually CTDB runs with real-time priority. This helps it to perform
211           effectively on a busy system, such as when there are thousands of
212           Samba clients. If you are running CTDB on a platform that does not
213           support real-time priority, you can set this to false.
214
215           Default: true
216
217       recmaster capability = true|false
218           Indicates whether a node can become the recovery master for the
219           cluster. If this is set to false then the node will not be able to
220           become the recovery master for the cluster. This feature is
221           primarily used for making a cluster span across a WAN link and use
222           CTDB as a WAN-accelerator.
223
224           Please see the REMOTE CLUSTER NODES section in ctdb(7) for more
225           information.
226
227           Default: true
228
229       lmaster capability = true|false
230           Indicates whether a node can become a location master for records
231           in a database. If this is set to false then the node will not be
232           part of the vnnmap. This feature is primarily used for making a
233           cluster span across a WAN link and use CTDB as a WAN-accelerator.
234
235           Please see the REMOTE CLUSTER NODES section in ctdb(7) for more
236           information.
237
238           Default: true
239
240       script log level = LOGLEVEL
241           This option sets the debug level of event script output to
242           LOGLEVEL.
243
244           See the DEBUG LEVELS section in ctdb(7) for more information.
245
246           Default: ERROR
247

FILES

249           /etc/ctdb/ctdb.conf
250

SEE ALSO

252       ctdbd(1), onnode(1), ctdb.sysconfig(5), ctdb-script.options(5),
253       ctdb(7), ctdb-tunables(7), http://ctdb.samba.org/
254

AUTHOR

256       This documentation was written by Amitay Isaacs, Martin Schwenke
257
259       Copyright © 2007 Andrew Tridgell, Ronnie Sahlberg
260
261       This program is free software; you can redistribute it and/or modify it
262       under the terms of the GNU General Public License as published by the
263       Free Software Foundation; either version 3 of the License, or (at your
264       option) any later version.
265
266       This program is distributed in the hope that it will be useful, but
267       WITHOUT ANY WARRANTY; without even the implied warranty of
268       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
269       General Public License for more details.
270
271       You should have received a copy of the GNU General Public License along
272       with this program; if not, see http://www.gnu.org/licenses.
273
274
275
276
277ctdb                              04/28/2020                      CTDB.CONF(5)
Impressum