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". With CTDB 4.4.0 and later this parameter is
76           ignored.
77
78           (optional, integer, default 100)
79
80       ctdb_start_as_disabled
81           When set to yes, the CTDB node will start in DISABLED mode and not
82           host any public ip addresses.
83
84           (optional, boolean, default no)
85
86       ctdb_config_dir
87           The directory containing various CTDB configuration files. The
88           "nodes" and "notify.sh" scripts are expected to be in this
89           directory.
90
91           (optional, string, default "/etc/ctdb")
92
93       ctdb_binary
94           Full path to the CTDB binary.
95
96           (optional, string, default "/usr/bin/ctdb")
97
98       ctdbd_binary
99           Full path to the CTDB cluster daemon binary.
100
101           (optional, string, default "/usr/sbin/ctdbd")
102
103       ctdb_socket
104           Full path to the domain socket that ctdbd will create, used for
105           local clients to attach and communicate with the ctdb daemon. With
106           CTDB 4.9.0 and later the socket path is hardcoded at build time, so
107           this parameter is ignored.
108
109           (unique, optional, string, default "/run/ctdb/ctdbd.socket")
110
111       ctdb_dbdir
112           The directory to put the local CTDB database files in. Persistent
113           database files will be put in ctdb_dbdir/persistent.
114
115           (unique, optional, string, default "/var/run")
116
117       ctdb_logfile
118           Full path to log file. To log to syslog instead, use the value
119           "syslog".
120
121           (optional, string, default "/var/log/ctdb/log.ctdb")
122
123       ctdb_rundir
124           Full path to ctdb runtime directory, used for storage of socket
125           lock state.
126
127           (optional, string, default "/run/ctdb")
128
129       ctdb_timeout
130           Indicates that ctdb should wait up to TIMEOUT seconds for a
131           response to most commands sent to the CTDB daemon.
132
133           (unique, optional, integer, default 10)
134
135       ctdb_debuglevel
136           What debug level to run at (0-10). Higher means more verbose.
137
138           (optional, integer, default 2)
139
140       ctdb_max_open_files
141           Maximum number of open files (for ulimit -n)
142
143           (optional, integer, no default)
144
145       smb_conf
146           Path to default samba config file. Only necessary if CTDB is
147           managing Samba.
148
149           (optional, string, default "/etc/samba/smb.conf")
150
151       smb_private_dir
152           The directory for smbd to use for storing such files as smbpasswd
153           and secrets.tdb. Old versions of CTBD (prior to 1.0.50) required
154           this to be on shared storage. This parameter should not be set for
155           current versions of CTDB, and only remains in the RA for backwards
156           compatibility.
157
158           (unique, optional, string, no default)
159
160       smb_passdb_backend
161           Which backend to use for storing user and possibly group
162           information. Only necessary if CTDB is managing Samba.
163
164           (optional, string, default "tdbsam")
165
166       smb_idmap_backend
167           Which backend to use for SID/uid/gid mapping. Only necessary if
168           CTDB is managing Samba.
169
170           (optional, string, default "tdb2")
171
172       smb_fileid_algorithm
173           Which fileid:algorithm to use with vfs_fileid. The correct value
174           depends on which clustered filesystem is in use, e.g.: for OCFS2,
175           this should be set to "fsid". Only necessary if CTDB is managing
176           Samba.
177
178           (optional, string, no default)
179

SUPPORTED ACTIONS

181       This resource agent supports the following actions (operations):
182
183       start
184           Starts the resource. Suggested minimum timeout: 90s.
185
186       stop
187           Stops the resource. Suggested minimum timeout: 100s.
188
189       monitor
190           Performs a detailed status check. Suggested minimum timeout: 20s.
191           Suggested interval: 10s.
192
193       meta-data
194           Retrieves resource agent metadata (internal use only). Suggested
195           minimum timeout: 5s.
196
197       validate-all
198           Performs a validation of the resource configuration. Suggested
199           minimum timeout: 30s.
200

EXAMPLE CRM SHELL

202       The following is an example configuration for a CTDB resource using the
203       crm(8) shell:
204
205           primitive p_CTDB ocf:heartbeat:CTDB \
206             params \
207               ctdb_recovery_lock=string \
208             op monitor timeout="20s" interval="10s" depth="0"
209

EXAMPLE PCS

211       The following is an example configuration for a CTDB resource using
212       pcs(8)
213
214           pcs resource create p_CTDB ocf:heartbeat:CTDB \
215             ctdb_recovery_lock=string \
216             op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"
217

AUTHOR

222       ClusterLabs contributors (see the resource agent source for information
223       about individual authors)
224
225
226
227resource-agents UNKNOWN           01/25/2023             OCF_HEARTBEAT_CTDB(7)