'\" t
.\"     Title: ocf_heartbeat_CTDB
.\"    Author: Linux-HA contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 02/03/2011
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 1.0.3
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_CTDB" "7" "02/03/2011" "resource-agents 1.0.3" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_CTDB \- CTDB Resource Agent
.SH "SYNOPSIS"
.HP \w'\fBCTDB\fR\ 'u
\fBCTDB\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This resource agent manages CTDB, allowing one to use Clustered Samba in a Linux\-HA/Pacemaker cluster\&. You need a shared filesystem (e\&.g\&. OCFS2) on which CTDB lock and Samba state will be stored\&. Configure shares in smb\&.conf on all nodes, and create /etc/ctdb/nodes containing a list of private IP addresses of each node in the cluster\&. Configure this RA as a clone, and it will take care of the rest\&. For more information see http://linux\-ha\&.org/wiki/CTDB_(resource_agent)
.SH "SUPPORTED PARAMETERS"
.PP
\fBctdb_recovery_lock\fR
.RS 4
The location of a shared lock file, common across all nodes\&. This must be on shared storage, e\&.g\&.: /shared\-fs/samba/ctdb\&.lock (required, string, no default)
.RE
.PP
\fBsmb_private_dir\fR
.RS 4
The directory for smbd to use for storing such files as smbpasswd and secrets\&.tdb\&. This must be on shared storage, e\&.g\&.: /shared\-fs/samba/private (required, string, no default)
.RE
.PP
\fBctdb_config_dir\fR
.RS 4
The directory containing various CTDB configuration files\&. The "nodes" and "notify\&.sh" scripts are expected to be in this directory, as is the "events\&.d" subdirectory\&. (optional, string, default
/etc/ctdb)
.RE
.PP
\fBctdb_binary\fR
.RS 4
Full path to the CTDB binary\&. (optional, string, default
/usr/bin/ctdb)
.RE
.PP
\fBctdbd_binary\fR
.RS 4
Full path to the CTDB cluster daemon binary\&. (optional, string, default
/usr/sbin/ctdbd)
.RE
.PP
\fBctdb_socket\fR
.RS 4
Full path to the domain socket that ctdbd will create, used for local clients to attach and communicate with the ctdb daemon\&. (optional, string, default
/var/lib/ctdb/ctdb\&.socket)
.RE
.PP
\fBctdb_dbdir\fR
.RS 4
The directory to put the local CTDB database files in\&. Persistent database files will be put in ctdb_dbdir/persistent\&. (optional, string, default
/var/lib/ctdb)
.RE
.PP
\fBctdb_logfile\fR
.RS 4
Full path to log file\&. To log to syslog instead, use the value "syslog"\&. (optional, string, default
/var/log/ctdb/log\&.ctdb)
.RE
.PP
\fBctdb_debuglevel\fR
.RS 4
What debug level to run at (0\-10)\&. Higher means more verbose\&. (optional, integer, default
2)
.RE
.PP
\fBsmb_conf\fR
.RS 4
Path to default samba config file\&. (optional, string, default
/etc/samba/smb\&.conf)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 90\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 100\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20\&. Suggested interval: 10\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 30\&.
.RE
.SH "EXAMPLE"
.PP
The following is an example configuration for a CTDB resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive example_CTDB ocf:heartbeat:CTDB \e
  params \e
    ctdb_recovery_lock=\fIstring\fR \e
    smb_private_dir=\fIstring\fR \e
  op monitor timeout="20" interval="10" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP

\m[blue]\fB\%http://www.linux-ha.org/wiki/CTDB_(resource_agent)\fR\m[]
.SH "AUTHOR"
.PP
\fBLinux\-HA contributors (see the resource agent source for information about individual authors)\fR