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) 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
20       For more information see http://linux-ha.org/wiki/CTDB_(resource_agent)
21

SUPPORTED PARAMETERS

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)
27
28       ctdb_manages_samba
29           Should CTDB manage starting/stopping the Samba service for you?
30           This will be deprecated in future, in favor of configuring a
31           separate Samba resource.  (optional, boolean, default no)
32
33       ctdb_manages_winbind
34           Should CTDB manage starting/stopping the Winbind service for you?
35           This will be deprecated in future, in favor of configuring a
36           separate Winbind resource.  (optional, boolean, default no)
37
38       ctdb_service_smb
39           Name of smb init script. Only necessary if CTDB is managing Samba
40           directly. Will usually be auto-detected.  (optional, string, no
41           default)
42
43       ctdb_service_nmb
44           Name of nmb init script. Only necessary if CTDB is managing Samba
45           directly. Will usually be auto-detected.  (optional, string, no
46           default)
47
48       ctdb_service_winbind
49           Name of winbind init script. Only necessary if CTDB is managing
50           Winbind directly. Will usually be auto-detected.  (optional,
51           string, no default)
52
53       ctdb_samba_skip_share_check
54           If there are very many shares it may not be feasible to check that
55           all of them are available during each monitoring interval. In that
56           case this check can be disabled.  (optional, boolean, default yes)
57
58       ctdb_monitor_free_memory
59           If the amount of free memory drops below this value the node will
60           become unhealthy and ctdb and all managed services will be
61           shutdown. Once this occurs, the administrator needs to find the
62           reason for the OOM situation, rectify it and restart ctdb with
63           "service ctdb start".  (optional, integer, default 100)
64
65       ctdb_start_as_disabled
66           When set to yes, the CTDB node will start in DISABLED mode and not
67           host any public ip addresses.  (optional, boolean, default yes)
68
69       ctdb_config_dir
70           The directory containing various CTDB configuration files. The
71           "nodes" and "notify.sh" scripts are expected to be in this
72           directory, as is the "events.d" subdirectory.  (optional, string,
73           default /etc/ctdb)
74
75       ctdb_binary
76           Full path to the CTDB binary.  (optional, string, default
77           /usr/bin/ctdb)
78
79       ctdbd_binary
80           Full path to the CTDB cluster daemon binary.  (optional, string,
81           default /usr/sbin/ctdbd)
82
83       ctdb_socket
84           Full path to the domain socket that ctdbd will create, used for
85           local clients to attach and communicate with the ctdb daemon.
86           (unique, optional, string, default /var/lib/ctdb/ctdb.socket)
87
88       ctdb_dbdir
89           The directory to put the local CTDB database files in. Persistent
90           database files will be put in ctdb_dbdir/persistent.  (unique,
91           optional, string, default /var/lib/ctdb)
92
93       ctdb_logfile
94           Full path to log file. To log to syslog instead, use the value
95           "syslog".  (optional, string, default /var/log/ctdb/log.ctdb)
96
97       ctdb_debuglevel
98           What debug level to run at (0-10). Higher means more verbose.
99           (optional, integer, default 2)
100
101       smb_conf
102           Path to default samba config file. Only necessary if CTDB is
103           managing Samba.  (optional, string, default /etc/samba/smb.conf)
104
105       smb_private_dir
106           The directory for smbd to use for storing such files as smbpasswd
107           and secrets.tdb. Old versions of CTBD (prior to 1.0.50) required
108           this to be on shared storage. This parameter should not be set for
109           current versions of CTDB, and only remains in the RA for backwards
110           compatibility.  (unique, optional, string, no default)
111
112       smb_passdb_backend
113           Which backend to use for storing user and possibly group
114           information. Only necessary if CTDB is managing Samba.  (optional,
115           string, default tdbsam)
116
117       smb_idmap_backend
118           Which backend to use for SID/uid/gid mapping. Only necessary if
119           CTDB is managing Samba.  (optional, string, default tdb2)
120

SUPPORTED ACTIONS

122       This resource agent supports the following actions (operations):
123
124       start
125           Starts the resource. Suggested minimum timeout: 90.
126
127       stop
128           Stops the resource. Suggested minimum timeout: 100.
129
130       monitor
131           Performs a detailed status check. Suggested minimum timeout: 20.
132           Suggested interval: 10.
133
134       meta-data
135           Retrieves resource agent metadata (internal use only). Suggested
136           minimum timeout: 5.
137
138       validate-all
139           Performs a validation of the resource configuration. Suggested
140           minimum timeout: 30.
141

EXAMPLE

143       The following is an example configuration for a CTDB resource using the
144       crm(8) shell:
145
146           primitive p_CTDB ocf:heartbeat:CTDB \
147             params \
148               ctdb_recovery_lock=string \
149             op monitor timeout="20" interval="10" depth="0"
150

SEE ALSO

152       http://www.linux-ha.org/wiki/CTDB_(resource_agent)
153

AUTHOR

155       Linux-HA contributors (see the resource agent source for information
156       about individual authors)
157
158
159
160resource-agents 3.9.2             07/08/2011             OCF_HEARTBEAT_CTDB(7)
Impressum