ctdb-web: Update manpages to current 4.6.5
[martins/ctdb-web.git] / web / manpages / ctdb_mutex_ceph_rados_helper.7.html
diff --git a/web/manpages/ctdb_mutex_ceph_rados_helper.7.html b/web/manpages/ctdb_mutex_ceph_rados_helper.7.html
new file mode 100644 (file)
index 0000000..dd70d3a
--- /dev/null
@@ -0,0 +1,26 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Ceph RADOS Mutex</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="ctdb_mutex_ceph_rados_helper.7"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb_mutex_ceph_rados_helper &#8212; Ceph RADOS cluster mutex helper</p></div><div class="refsect1"><a name="idm140124588809200"></a><h2>DESCRIPTION</h2><p>
+      ctdb_mutex_ceph_rados_helper can be used as a recovery lock provider
+      for CTDB.  When configured, split brain avoidance during CTDB recovery
+      will be handled using locks against an object located in a Ceph RADOS
+      pool.
+      To enable this functionality, include the following line in your CTDB
+      config file:
+    </p><pre class="screen">
+CTDB_RECOVERY_LOCK="!ctdb_mutex_ceph_rados_helper [Cluster] [User] [Pool] [Object]"
+
+Cluster: Ceph cluster name (e.g. ceph)
+User: Ceph cluster user name (e.g. client.admin)
+Pool: Ceph RADOS pool name
+Object: Ceph RADOS object name
+    </pre><p>
+      The Ceph cluster <em class="parameter"><code>Cluster</code></em> must be up and running,
+      with a configuration, and keyring file for <em class="parameter"><code>User</code></em>
+      located in a librados default search path (e.g. /etc/ceph/).
+      <em class="parameter"><code>Pool</code></em> must already exist.
+    </p></div><div class="refsect1"><a name="idm140124588179520"></a><h2>SEE ALSO</h2><p>
+      <span class="citerefentry"><span class="refentrytitle">ctdb</span>(7)</span>,
+
+      <span class="citerefentry"><span class="refentrytitle">ctdbd</span>(1)</span>,
+
+      <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
+    </p></div></div></body></html>