ocf_heartbeat_CTDB(7)

1OCF_HEARTBEAT_CTDB(7)         OCF resource agents        OCF_HEARTBEAT_CTDB(7)
2
3
4

NAME

6       ocf_heartbeat_CTDB - CTDB Resource Agent
7

SYNOPSIS

9       CTDB [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       This resource agent manages CTDB, allowing one to use Clustered Samba
13       in a Linux-HA/Pacemaker cluster. You need a shared filesystem (e.g.
14       OCFS2 or GFS2) on which the CTDB lock will be stored. Create
15       /etc/ctdb/nodes containing a list of private IP addresses of each node
16       in the cluster, then configure this RA as a clone. This agent expects
17       the samba and windbind resources to be managed outside of CTDB's
18       control as a separate set of resources controlled by the cluster
19       manager. The optional support for enabling CTDB management of these
20       daemons will be depreciated.
21
22       For more information see http://linux-ha.org/wiki/CTDB_(resource_agent)
23

SUPPORTED PARAMETERS

25       ctdb_recovery_lock
26           The location of a shared lock file or helper binary, common across
27           all nodes. See CTDB documentation for details.
28
29           (unique, required, string, no default)
30
31       ctdb_manages_samba
32           Should CTDB manage starting/stopping the Samba service for you?
33           This will be deprecated in future, in favor of configuring a
34           separate Samba resource.
35
36           (optional, boolean, default no)
37
38       ctdb_manages_winbind
39           Should CTDB manage starting/stopping the Winbind service for you?
40           This will be deprecated in future, in favor of configuring a
41           separate Winbind resource.
42
43           (optional, boolean, default no)
44
45       ctdb_service_smb
46           Name of smb init script. Only necessary if CTDB is managing Samba
47           directly. Will usually be auto-detected.
48
49           (optional, string, no default)
50
51       ctdb_service_nmb
52           Name of nmb init script. Only necessary if CTDB is managing Samba
53           directly. Will usually be auto-detected.
54
55           (optional, string, no default)
56
57       ctdb_service_winbind
58           Name of winbind init script. Only necessary if CTDB is managing
59           Winbind directly. Will usually be auto-detected.
60
61           (optional, string, no default)
62
63       ctdb_samba_skip_share_check
64           If there are very many shares it may not be feasible to check that
65           all of them are available during each monitoring interval. In that
66           case this check can be disabled.
67
68           (optional, boolean, default yes)
69
70       ctdb_monitor_free_memory
71           If the amount of free memory drops below this value the node will
72           become unhealthy and ctdb and all managed services will be
73           shutdown. Once this occurs, the administrator needs to find the
74           reason for the OOM situation, rectify it and restart ctdb with
75           "service ctdb start".
76
77           (optional, integer, default 100)
78
79       ctdb_start_as_disabled
80           When set to yes, the CTDB node will start in DISABLED mode and not
81           host any public ip addresses.
82
83           (optional, boolean, default no)
84
85       ctdb_config_dir
86           The directory containing various CTDB configuration files. The
87           "nodes" and "notify.sh" scripts are expected to be in this
88           directory, as is the "events.d" subdirectory.
89
90           (optional, string, default "/etc/ctdb")
91
92       ctdb_binary
93           Full path to the CTDB binary.
94
95           (optional, string, default "/usr/bin/ctdb")
96
97       ctdbd_binary
98           Full path to the CTDB cluster daemon binary.
99
100           (optional, string, default "/usr/sbin/ctdbd")
101
102       ctdb_socket
103           Full path to the domain socket that ctdbd will create, used for
104           local clients to attach and communicate with the ctdb daemon.
105
106           (unique, optional, string, default "/run/ctdb/ctdbd.socket")
107
108       ctdb_dbdir
109           The directory to put the local CTDB database files in. Persistent
110           database files will be put in ctdb_dbdir/persistent.
111
112           (unique, optional, string, default "/var/run")
113
114       ctdb_logfile
115           Full path to log file. To log to syslog instead, use the value
116           "syslog".
117
118           (optional, string, default "/var/log/ctdb/log.ctdb")
119
120       ctdb_rundir
121           Full path to ctdb runtime directory, used for storage of socket
122           lock state.
123
124           (optional, string, default "/run/ctdb")
125
126       ctdb_debuglevel
127           What debug level to run at (0-10). Higher means more verbose.
128
129           (optional, integer, default 2)
130
131       smb_conf
132           Path to default samba config file. Only necessary if CTDB is
133           managing Samba.
134
135           (optional, string, default "/etc/samba/smb.conf")
136
137       smb_private_dir
138           The directory for smbd to use for storing such files as smbpasswd
139           and secrets.tdb. Old versions of CTBD (prior to 1.0.50) required
140           this to be on shared storage. This parameter should not be set for
141           current versions of CTDB, and only remains in the RA for backwards
142           compatibility.
143
144           (unique, optional, string, no default)
145
146       smb_passdb_backend
147           Which backend to use for storing user and possibly group
148           information. Only necessary if CTDB is managing Samba.
149
150           (optional, string, default "tdbsam")
151
152       smb_idmap_backend
153           Which backend to use for SID/uid/gid mapping. Only necessary if
154           CTDB is managing Samba.
155
156           (optional, string, default "tdb2")
157
158       smb_fileid_algorithm
159           Which fileid:algorithm to use with vfs_fileid. The correct value
160           depends on which clustered filesystem is in use, e.g.: for OCFS2,
161           this should be set to "fsid". Only necessary if CTDB is managing
162           Samba.
163
164           (optional, string, no default)
165

SUPPORTED ACTIONS

167       This resource agent supports the following actions (operations):
168
169       start
170           Starts the resource. Suggested minimum timeout: 90s.
171
172       stop
173           Stops the resource. Suggested minimum timeout: 100s.
174
175       monitor
176           Performs a detailed status check. Suggested minimum timeout: 20s.
177           Suggested interval: 10s.
178
179       meta-data
180           Retrieves resource agent metadata (internal use only). Suggested
181           minimum timeout: 5s.
182
183       validate-all
184           Performs a validation of the resource configuration. Suggested
185           minimum timeout: 30s.
186

EXAMPLE CRM SHELL

188       The following is an example configuration for a CTDB resource using the
189       crm(8) shell:
190
191           primitive p_CTDB ocf:heartbeat:CTDB \
192             params \
193               ctdb_recovery_lock=string \
194             op monitor timeout="20s" interval="10s" depth="0"
195

EXAMPLE PCS

197       The following is an example configuration for a CTDB resource using
198       pcs(8)
199
200           pcs resource create p_CTDB ocf:heartbeat:CTDB \
201             ctdb_recovery_lock=string \
202             op monitor timeout="20s" interval="10s" depth="0"
203

AUTHOR

208       ClusterLabs contributors (see the resource agent source for information
209       about individual authors)
210
211
212
213resource-agents UNKNOWN           03/15/2019             OCF_HEARTBEAT_CTDB(7)