'\" t
.\"     Title: ocf_heartbeat_CTDB
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/17/2020
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_CTDB" "7" "12/17/2020" "resource-agents UNKNOWN" "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 or GFS2) on which the CTDB lock will be stored\&. Create /etc/ctdb/nodes containing a list of private IP addresses of each node in the cluster, then configure this RA as a clone\&. This agent expects the samba and windbind resources to be managed outside of CTDB\*(Aqs control as a separate set of resources controlled by the cluster manager\&. The optional support for enabling CTDB management of these daemons will be depreciated\&.
.PP
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 or helper binary, common across all nodes\&. See CTDB documentation for details\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBctdb_manages_samba\fR
.RS 4
Should CTDB manage starting/stopping the Samba service for you? This will be deprecated in future, in favor of configuring a separate Samba resource\&.
.sp
(optional, boolean, default
no)
.RE
.PP
\fBctdb_manages_winbind\fR
.RS 4
Should CTDB manage starting/stopping the Winbind service for you? This will be deprecated in future, in favor of configuring a separate Winbind resource\&.
.sp
(optional, boolean, default
no)
.RE
.PP
\fBctdb_service_smb\fR
.RS 4
Name of smb init script\&. Only necessary if CTDB is managing Samba directly\&. Will usually be auto\-detected\&.
.sp
(optional, string, no default)
.RE
.PP
\fBctdb_service_nmb\fR
.RS 4
Name of nmb init script\&. Only necessary if CTDB is managing Samba directly\&. Will usually be auto\-detected\&.
.sp
(optional, string, no default)
.RE
.PP
\fBctdb_service_winbind\fR
.RS 4
Name of winbind init script\&. Only necessary if CTDB is managing Winbind directly\&. Will usually be auto\-detected\&.
.sp
(optional, string, no default)
.RE
.PP
\fBctdb_samba_skip_share_check\fR
.RS 4
If there are very many shares it may not be feasible to check that all of them are available during each monitoring interval\&. In that case this check can be disabled\&.
.sp
(optional, boolean, default
yes)
.RE
.PP
\fBctdb_monitor_free_memory\fR
.RS 4
If the amount of free memory drops below this value the node will become unhealthy and ctdb and all managed services will be shutdown\&. Once this occurs, the administrator needs to find the reason for the OOM situation, rectify it and restart ctdb with "service ctdb start"\&. With CTDB 4\&.4\&.0 and later this parameter is ignored\&.
.sp
(optional, integer, default
100)
.RE
.PP
\fBctdb_start_as_disabled\fR
.RS 4
When set to yes, the CTDB node will start in DISABLED mode and not host any public ip addresses\&.
.sp
(optional, boolean, default
no)
.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\&.
.sp
(optional, string, default "/etc/ctdb")
.RE
.PP
\fBctdb_binary\fR
.RS 4
Full path to the CTDB binary\&.
.sp
(optional, string, default "/usr/bin/ctdb")
.RE
.PP
\fBctdbd_binary\fR
.RS 4
Full path to the CTDB cluster daemon binary\&.
.sp
(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\&. With CTDB 4\&.9\&.0 and later the socket path is hardcoded at build time, so this parameter is ignored\&.
.sp
(unique, optional, string, default "/run/ctdb/ctdbd\&.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\&.
.sp
(unique, optional, string, default "/var/run")
.RE
.PP
\fBctdb_logfile\fR
.RS 4
Full path to log file\&. To log to syslog instead, use the value "syslog"\&.
.sp
(optional, string, default "/var/log/ctdb/log\&.ctdb")
.RE
.PP
\fBctdb_rundir\fR
.RS 4
Full path to ctdb runtime directory, used for storage of socket lock state\&.
.sp
(optional, string, default "/run/ctdb")
.RE
.PP
\fBctdb_debuglevel\fR
.RS 4
What debug level to run at (0\-10)\&. Higher means more verbose\&.
.sp
(optional, integer, default
2)
.RE
.PP
\fBctdb_max_open_files\fR
.RS 4
Maximum number of open files (for ulimit \-n)
.sp
(optional, integer, no default)
.RE
.PP
\fBsmb_conf\fR
.RS 4
Path to default samba config file\&. Only necessary if CTDB is managing Samba\&.
.sp
(optional, string, default "/etc/samba/smb\&.conf")
.RE
.PP
\fBsmb_private_dir\fR
.RS 4
The directory for smbd to use for storing such files as smbpasswd and secrets\&.tdb\&. Old versions of CTBD (prior to 1\&.0\&.50) required this to be on shared storage\&. This parameter should not be set for current versions of CTDB, and only remains in the RA for backwards compatibility\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBsmb_passdb_backend\fR
.RS 4
Which backend to use for storing user and possibly group information\&. Only necessary if CTDB is managing Samba\&.
.sp
(optional, string, default "tdbsam")
.RE
.PP
\fBsmb_idmap_backend\fR
.RS 4
Which backend to use for SID/uid/gid mapping\&. Only necessary if CTDB is managing Samba\&.
.sp
(optional, string, default "tdb2")
.RE
.PP
\fBsmb_fileid_algorithm\fR
.RS 4
Which fileid:algorithm to use with vfs_fileid\&. The correct value depends on which clustered filesystem is in use, e\&.g\&.: for OCFS2, this should be set to "fsid"\&. Only necessary if CTDB is managing Samba\&.
.sp
(optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 90s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 100s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 30s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a CTDB resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_CTDB ocf:heartbeat:CTDB \e
  params \e
    ctdb_recovery_lock=\fIstring\fR \e
  op monitor timeout="20s" interval="10s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a CTDB resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_CTDB ocf:heartbeat:CTDB \e
  ctdb_recovery_lock=\fIstring\fR \e
  op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR