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     <para>
  46       For informational purposes, ctdb_mutex_ceph_rados_helper will also
  47       register the recovery lock holder in Ceph Manager's service map.
  48     </para>
  49   </refsect1>
  50
  51   <refsect1>
  52     <title>SEE ALSO</title>
  53     <para>
  54       <citerefentry><refentrytitle>ctdb</refentrytitle>
  55       <manvolnum>7</manvolnum></citerefentry>,
  56
  57       <citerefentry><refentrytitle>ctdbd</refentrytitle>
  58       <manvolnum>1</manvolnum></citerefentry>,
  59
  60       <ulink url="http://ctdb.samba.org/"/>
  61     </para>
  62   </refsect1>
  63
  64   <refentryinfo>
  65     <author>
  66       <contrib>
  67         This documentation was written by David Disseldorp
  68       </contrib>
  69     </author>
  70
  71     <copyright>
  72       <year>2016</year>
  73       <holder>David Disseldorp</holder>
  74     </copyright>
  75     <legalnotice>
  76       <para>
  77         This program is free software; you can redistribute it and/or
  78         modify it under the terms of the GNU General Public License as
  79         published by the Free Software Foundation; either version 3 of
  80         the License, or (at your option) any later version.
  81       </para>
  82       <para>
  83         This program is distributed in the hope that it will be
  84         useful, but WITHOUT ANY WARRANTY; without even the implied
  85         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  86         PURPOSE.  See the GNU General Public License for more details.
  87       </para>
  88       <para>
  89         You should have received a copy of the GNU General Public
  90         License along with this program; if not, see
  91         <ulink url="http://www.gnu.org/licenses"/>.
  92       </para>
  93     </legalnotice>
  94   </refentryinfo>
  95
  96 </refentry>