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 your CTDB
  27       config file:
  28     </para>
  29     <screen format="linespecific">
  30 CTDB_RECOVERY_LOCK="!ctdb_mutex_ceph_rados_helper [Cluster] [User] [Pool] [Object]"
  31
  32 Cluster: Ceph cluster name (e.g. ceph)
  33 User: Ceph cluster user name (e.g. client.admin)
  34 Pool: Ceph RADOS pool name
  35 Object: Ceph RADOS object name
  36     </screen>
  37     <para>
  38       The Ceph cluster <parameter>Cluster</parameter> must be up and running,
  39       with a configuration, and keyring file for <parameter>User</parameter>
  40       located in a librados default search path (e.g. /etc/ceph/).
  41       <parameter>Pool</parameter> must already exist.
  42     </para>
  43   </refsect1>
  44
  45   <refsect1>
  46     <title>SEE ALSO</title>
  47     <para>
  48       <citerefentry><refentrytitle>ctdb</refentrytitle>
  49       <manvolnum>7</manvolnum></citerefentry>,
  50
  51       <citerefentry><refentrytitle>ctdbd</refentrytitle>
  52       <manvolnum>1</manvolnum></citerefentry>,
  53
  54       <ulink url="http://ctdb.samba.org/"/>
  55     </para>
  56   </refsect1>
  57
  58   <refentryinfo>
  59     <author>
  60       <contrib>
  61         This documentation was written by David Disseldorp
  62       </contrib>
  63     </author>
  64
  65     <copyright>
  66       <year>2016</year>
  67       <holder>David Disseldorp</holder>
  68     </copyright>
  69     <legalnotice>
  70       <para>
  71         This program is free software; you can redistribute it and/or
  72         modify it under the terms of the GNU General Public License as
  73         published by the Free Software Foundation; either version 3 of
  74         the License, or (at your option) any later version.
  75       </para>
  76       <para>
  77         This program is distributed in the hope that it will be
  78         useful, but WITHOUT ANY WARRANTY; without even the implied
  79         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  80         PURPOSE.  See the GNU General Public License for more details.
  81       </para>
  82       <para>
  83         You should have received a copy of the GNU General Public
  84         License along with this program; if not, see
  85         <ulink url="http://www.gnu.org/licenses"/>.
  86       </para>
  87     </legalnotice>
  88   </refentryinfo>
  89
  90 </refentry>