CTDB Documentation
Most documentation about how to install and configure CTDB is available in the CTDB Wiki. It covers cluster filesystem setup, basic and advanced configuration, and troubleshooting.
CTDB no longer ships as a separate release. Its manual pages are generated and versioned
together with Samba, so the list below always reflects the CTDB that shipped with the
current stable Samba release (4.24.x).
User commands
| Page | Description |
|---|---|
| ctdb(1) | Main command-line tool for managing and querying a CTDB cluster. |
| ctdbd(1) | The CTDB cluster daemon. Not normally invoked directly — see ctdbd_wrapper(1). |
| ctdbd_wrapper(1) | Wrapper script that starts ctdbd with options read from ctdbd.conf. |
| ctdb_diagnostics(1) | Collects configuration and log information from all cluster nodes for troubleshooting. |
| onnode(1) | Runs a command on one, several, or all nodes of a CTDB cluster. |
| ltdbtool(1) | Inspects and repairs local TDB database files used by CTDB. |
| ping_pong(1) | Benchmarking tool for testing byte-range locking performance on a cluster filesystem. |
Configuration & file formats
| Page | Description |
|---|---|
| ctdb.conf(5) | Main CTDB daemon configuration file. |
| ctdb-script.options(5) | Options controlling CTDB's event and management scripts. |
| ctdb.sysconfig(5) | Legacy sysconfig-style configuration variables, kept for compatibility. |
Overview & reference
| Page | Description |
|---|---|
| ctdb(7) | General overview of CTDB concepts: leader election, cluster lock, IP takeover, recovery. |
| ctdb-tunables(7) | Full list of runtime-tunable CTDB parameters. |
| ctdb-statistics(7) | Explains the fields shown by ctdb statistics and related commands. |
| ctdb-etcd(7) | Using an etcd cluster as the CTDB cluster lock backend. |
| ctdb_mutex_ceph_rados_helper(7) | Using a Ceph RADOS object as the CTDB cluster lock backend. |
These pages are built from the same Samba release that generates the man pages installed by your distribution's ctdb package, so page content matches whatever Samba/CTDB version you have installed — check ctdb version locally if in doubt.
Guides on the Wiki
- CTDB and Clustered Samba — overview and starting point
- Basic CTDB configuration
- Configuring clustered Samba
- Samba/CTDB/GlusterFS cluster how-to