1OCF_HEARTBEAT_CTDB(7) OCF resource agents OCF_HEARTBEAT_CTDB(7)
2
6 ocf_heartbeat_CTDB - CTDB Resource Agent
7
9 CTDB [start | stop | monitor | meta-data | validate-all]
10
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) on which the CTDB lock will be stored. Create /etc/ctdb/nodes
15 containing a list of private IP addresses of each node in the cluster,
16 then configure this RA as a clone. To have CTDB manage Samba, set
17 ctdb_manages_samba="yes". Note that this option will be deprecated in
18 future, in favour of configuring a separate Samba resource.
19 For more information see http://linux-ha.org/wiki/CTDB_(resource_agent)
21
23 ctdb_recovery_lock
24 The location of a shared lock file, common across all nodes. This
25 must be on shared storage, e.g.: /shared-fs/samba/ctdb.lock
26 (unique, required, string, no default)
28 ctdb_manages_samba
30 Should CTDB manage starting/stopping the Samba service for you?
31 This will be deprecated in future, in favor of configuring a
32 separate Samba resource.
33 (optional, boolean, default no)
35 ctdb_manages_winbind
37 Should CTDB manage starting/stopping the Winbind service for you?
38 This will be deprecated in future, in favor of configuring a
39 separate Winbind resource.
40 (optional, boolean, default no)
42 ctdb_service_smb
44 Name of smb init script. Only necessary if CTDB is managing Samba
45 directly. Will usually be auto-detected.
46 (optional, string, no default)
48 ctdb_service_nmb
50 Name of nmb init script. Only necessary if CTDB is managing Samba
51 directly. Will usually be auto-detected.
52 (optional, string, no default)
54 ctdb_service_winbind
56 Name of winbind init script. Only necessary if CTDB is managing
57 Winbind directly. Will usually be auto-detected.
58 (optional, string, no default)
60 ctdb_samba_skip_share_check
62 If there are very many shares it may not be feasible to check that
63 all of them are available during each monitoring interval. In that
64 case this check can be disabled.
65 (optional, boolean, default yes)
67 ctdb_monitor_free_memory
69 If the amount of free memory drops below this value the node will
70 become unhealthy and ctdb and all managed services will be
71 shutdown. Once this occurs, the administrator needs to find the
72 reason for the OOM situation, rectify it and restart ctdb with
73 "service ctdb start".
74 (optional, integer, default 100)
76 ctdb_start_as_disabled
78 When set to yes, the CTDB node will start in DISABLED mode and not
79 host any public ip addresses.
80 (optional, boolean, default no)
82 ctdb_config_dir
84 The directory containing various CTDB configuration files. The
85 "nodes" and "notify.sh" scripts are expected to be in this
86 directory, as is the "events.d" subdirectory.
87 (optional, string, default "/etc/ctdb")
89 ctdb_binary
91 Full path to the CTDB binary.
92 (optional, string, default "/usr/bin/ctdb")
94 ctdbd_binary
96 Full path to the CTDB cluster daemon binary.
97 (optional, string, default "/usr/sbin/ctdbd")
99 ctdb_socket
101 Full path to the domain socket that ctdbd will create, used for
102 local clients to attach and communicate with the ctdb daemon.
103 (unique, optional, string, default "/var/lib/ctdb/ctdb.socket")
105 ctdb_dbdir
107 The directory to put the local CTDB database files in. Persistent
108 database files will be put in ctdb_dbdir/persistent.
109 (unique, optional, string, default "/var/lib/ctdb")
111 ctdb_logfile
113 Full path to log file. To log to syslog instead, use the value
114 "syslog".
115 (optional, string, default "/var/log/ctdb/log.ctdb")
117 ctdb_debuglevel
119 What debug level to run at (0-10). Higher means more verbose.
120 (optional, integer, default 2)
122 smb_conf
124 Path to default samba config file. Only necessary if CTDB is
125 managing Samba.
126 (optional, string, default "/etc/samba/smb.conf")
128 smb_private_dir
130 The directory for smbd to use for storing such files as smbpasswd
131 and secrets.tdb. Old versions of CTBD (prior to 1.0.50) required
132 this to be on shared storage. This parameter should not be set for
133 current versions of CTDB, and only remains in the RA for backwards
134 compatibility.
135 (unique, optional, string, no default)
137 smb_passdb_backend
139 Which backend to use for storing user and possibly group
140 information. Only necessary if CTDB is managing Samba.
141 (optional, string, default "tdbsam")
143 smb_idmap_backend
145 Which backend to use for SID/uid/gid mapping. Only necessary if
146 CTDB is managing Samba.
147 (optional, string, default "tdb2")
149 smb_fileid_algorithm
151 Which fileid:algorithm to use with vfs_fileid. The correct value
152 depends on which clustered filesystem is in use, e.g.: for OCFS2,
153 this should be set to "fsid". Only necessary if CTDB is managing
154 Samba.
155 (optional, string, no default)
157
159 This resource agent supports the following actions (operations):
160 start
162 Starts the resource. Suggested minimum timeout: 90.
163 stop
165 Stops the resource. Suggested minimum timeout: 100.
166 monitor
168 Performs a detailed status check. Suggested minimum timeout: 20.
169 Suggested interval: 10.
170 meta-data
172 Retrieves resource agent metadata (internal use only). Suggested
173 minimum timeout: 5.
174 validate-all
176 Performs a validation of the resource configuration. Suggested
177 minimum timeout: 30.
178
180 The following is an example configuration for a CTDB resource using the
181 crm(8) shell:
182 primitive p_CTDB ocf:heartbeat:CTDB \
184 params \
185 ctdb_recovery_lock=string \
186 op monitor timeout="20" interval="10" depth="0"
187
189 http://www.linux-ha.org/wiki/CTDB_(resource_agent)
190
192 Linux-HA contributors (see the resource agent source for information
193 about individual authors)
194resource-agents 3.9.2 03/24/2017 OCF_HEARTBEAT_CTDB(7)