ctdb/doc/ctdb-etcd.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-etcd.7">
   6
   7   <refentryinfo>
   8     <author>
   9       <contrib>
  10         This documentation was written by
  11         Jose A. Rivera
  12       </contrib>
  13     </author>
  14
  15     <copyright>
  16       <year>2016</year>
  17       <holder>Jose A. Rivera</holder>
  18     </copyright>
  19     <legalnotice>
  20       <para>
  21         This program is free software; you can redistribute it and/or
  22         modify it under the terms of the GNU General Public License as
  23         published by the Free Software Foundation; either version 3 of
  24         the License, or (at your option) any later version.
  25       </para>
  26       <para>
  27         This program is distributed in the hope that it will be
  28         useful, but WITHOUT ANY WARRANTY; without even the implied
  29         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  30         PURPOSE.  See the GNU General Public License for more details.
  31       </para>
  32       <para>
  33         You should have received a copy of the GNU General Public
  34         License along with this program; if not, see
  35         <ulink url="http://www.gnu.org/licenses"/>.
  36       </para>
  37     </legalnotice>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>ctdb-etcd</refentrytitle>
  42     <manvolnum>7</manvolnum>
  43     <refmiscinfo class="source">ctdb</refmiscinfo>
  44     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
  45   </refmeta>
  46
  47   <refnamediv>
  48     <refname>ctdb-etcd</refname>
  49     <refpurpose>CTDB etcd integration</refpurpose>
  50   </refnamediv>
  51
  52   <refsynopsisdiv>
  53     <cmdsynopsis>
  54       <command>ctdb_etcd_lock</command>
  55     </cmdsynopsis>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>DESCRIPTION</title>
  60     <para>
  61       ctdb_etcd_lock is intended to be run as a mutex helper for CTDB. It
  62       will try to connect to an existing etcd cluster and grab a lock in that
  63       cluster to function as CTDB's cluster lock. Please see
  64       <emphasis>ctdb/doc/cluster_mutex_helper.txt</emphasis> for details on
  65       the mutex helper API. To use this, include the following line in
  66       the <literal>[cluster]</literal> section of
  67       <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
  68       <manvolnum>5</manvolnum></citerefentry>:
  69     </para>
  70     <screen format="linespecific">
  71 cluster lock = !/usr/local/usr/libexec/ctdb/ctdb_etcd_lock
  72     </screen>
  73     <para>
  74       You can also pass "-v", "-vv", or "-vvv" to include verbose output in
  75       the CTDB log. Additional "v"s indicate increases in verbosity.
  76     </para>
  77     <para>
  78       This mutex helper expects the system Python interpreter to have access
  79       to the etcd Python module. It also expects an etcd cluster to be
  80       configured and running. To integrate with this, there is an optional
  81       config file of the following format:
  82     </para>
  83     <screen format="linespecific">
  84 key = value
  85     </screen>
  86     <para>
  87       The following configuration parameters (and their defaults) are defined
  88       for use by ctdb_etcd_lock:
  89     </para>
  90     <screen format="linespecific">
  91 port      = 2379   # connecting port for the etcd cluster
  92 lock_ttl  = 9      # seconds for TTL
  93 refresh   = 2      # seconds between attempts to maintain lock
  94 locks_dir = _ctdb  # where to store CTDB locks in etcd
  95                    # The final etcd directory for any given lock looks like:
  96                    #   /_locks/{locks_dir}/{netbios name}/
  97     </screen>
  98     <para>
  99       In addition, any keyword parameter that can be used to configure an
 100       etcd client may be specified and modified here. For more documentation
 101       on these parameters, see here: https://github.com/jplana/python-etcd/
 102     </para>
 103   </refsect1>
 104
 105   <refsect1>
 106     <title>SEE ALSO</title>
 107     <para>
 108       <citerefentry><refentrytitle>ctdb</refentrytitle>
 109       <manvolnum>7</manvolnum></citerefentry>,
 110
 111       <citerefentry><refentrytitle>ctdbd</refentrytitle>
 112       <manvolnum>1</manvolnum></citerefentry>,
 113
 114       <ulink url="http://ctdb.samba.org/"/>
 115     </para>
 116   </refsect1>
 117
 118
 119 </refentry>