ctdb/doc/ctdb_mutex_ceph_rados_helper.7.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   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 cluster 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 cluster lock = !ctdb_mutex_ceph_rados_helper [Cluster] [User] [Pool] [Object] [Timeout] [-n Namespace]
  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 Timeout: Ceph RADOS lock duration in seconds (optional)
  39 Namespace: Ceph RADOS pool namespace (optional)
  40     </screen>
  41     <para>
  42       The Ceph cluster <parameter>Cluster</parameter> must be up and running,
  43       with a configuration, and keyring file for <parameter>User</parameter>
  44       located in a librados default search path (e.g. /etc/ceph/).
  45       <parameter>Pool</parameter> must already exist.
  46     </para>
  47     <para>
  48       For informational purposes, ctdb_mutex_ceph_rados_helper will also
  49       register the cluster lock holder in Ceph Manager's service map.
  50     </para>
  51   </refsect1>
  52
  53   <refsect1>
  54     <title>SEE ALSO</title>
  55     <para>
  56       <citerefentry><refentrytitle>ctdb</refentrytitle>
  57       <manvolnum>7</manvolnum></citerefentry>,
  58
  59       <citerefentry><refentrytitle>ctdbd</refentrytitle>
  60       <manvolnum>1</manvolnum></citerefentry>,
  61
  62       <ulink url="http://ctdb.samba.org/"/>
  63     </para>
  64   </refsect1>
  65
  66   <refentryinfo>
  67     <author>
  68       <contrib>
  69         This documentation was written by David Disseldorp
  70       </contrib>
  71     </author>
  72
  73     <copyright>
  74       <year>2016</year>
  75       <holder>David Disseldorp</holder>
  76     </copyright>
  77     <legalnotice>
  78       <para>
  79         This program is free software; you can redistribute it and/or
  80         modify it under the terms of the GNU General Public License as
  81         published by the Free Software Foundation; either version 3 of
  82         the License, or (at your option) any later version.
  83       </para>
  84       <para>
  85         This program is distributed in the hope that it will be
  86         useful, but WITHOUT ANY WARRANTY; without even the implied
  87         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  88         PURPOSE.  See the GNU General Public License for more details.
  89       </para>
  90       <para>
  91         You should have received a copy of the GNU General Public
  92         License along with this program; if not, see
  93         <ulink url="http://www.gnu.org/licenses"/>.
  94       </para>
  95     </legalnotice>
  96   </refentryinfo>
  97
  98 </refentry>