ctdb/doc/ctdb_mutex_ceph_rados_helper.7.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry
   3         PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   5 <refentry id="ctdb_mutex_ceph_rados_helper.7">
   6
   7   <refmeta>
   8     <refentrytitle>Ceph RADOS Mutex</refentrytitle>
   9     <manvolnum>7</manvolnum>
  10     <refmiscinfo class="source">ctdb</refmiscinfo>
  11     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
  12   </refmeta>
  13
  14   <refnamediv>
  15     <refname>ctdb_mutex_ceph_rados_helper</refname>
  16     <refpurpose>Ceph RADOS cluster mutex helper</refpurpose>
  17   </refnamediv>
  18
  19   <refsect1>
  20     <title>DESCRIPTION</title>
  21     <para>
  22       ctdb_mutex_ceph_rados_helper can be used as a recovery lock provider
  23       for CTDB.  When configured, split brain avoidance during CTDB recovery
  24       will be handled using locks against an object located in a Ceph RADOS
  25       pool.
  26       To enable this functionality, include the following line in the
  27       <literal>[cluster]</literal> section of
  28       <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
  29       <manvolnum>5</manvolnum></citerefentry>:
  30     </para>
  31     <screen format="linespecific">
  32 recovery lock = !ctdb_mutex_ceph_rados_helper [Cluster] [User] [Pool] [Object]
  33
  34 Cluster: Ceph cluster name (e.g. ceph)
  35 User: Ceph cluster user name (e.g. client.admin)
  36 Pool: Ceph RADOS pool name
  37 Object: Ceph RADOS object name
  38     </screen>
  39     <para>
  40       The Ceph cluster <parameter>Cluster</parameter> must be up and running,
  41       with a configuration, and keyring file for <parameter>User</parameter>
  42       located in a librados default search path (e.g. /etc/ceph/).
  43       <parameter>Pool</parameter> must already exist.
  44     </para>
  45   </refsect1>
  46
  47   <refsect1>
  48     <title>SEE ALSO</title>
  49     <para>
  50       <citerefentry><refentrytitle>ctdb</refentrytitle>
  51       <manvolnum>7</manvolnum></citerefentry>,
  52
  53       <citerefentry><refentrytitle>ctdbd</refentrytitle>
  54       <manvolnum>1</manvolnum></citerefentry>,
  55
  56       <ulink url="http://ctdb.samba.org/"/>
  57     </para>
  58   </refsect1>
  59
  60   <refentryinfo>
  61     <author>
  62       <contrib>
  63         This documentation was written by David Disseldorp
  64       </contrib>
  65     </author>
  66
  67     <copyright>
  68       <year>2016</year>
  69       <holder>David Disseldorp</holder>
  70     </copyright>
  71     <legalnotice>
  72       <para>
  73         This program is free software; you can redistribute it and/or
  74         modify it under the terms of the GNU General Public License as
  75         published by the Free Software Foundation; either version 3 of
  76         the License, or (at your option) any later version.
  77       </para>
  78       <para>
  79         This program is distributed in the hope that it will be
  80         useful, but WITHOUT ANY WARRANTY; without even the implied
  81         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  82         PURPOSE.  See the GNU General Public License for more details.
  83       </para>
  84       <para>
  85         You should have received a copy of the GNU General Public
  86         License along with this program; if not, see
  87         <ulink url="http://www.gnu.org/licenses"/>.
  88       </para>
  89     </legalnotice>
  90   </refentryinfo>
  91
  92 </refentry>