mirror of
https://git.freebsd.org/ports.git
synced 2025-06-14 09:10:32 -04:00
6b4c4bd993
Still experimental and version 4.7.4 is coming shortly, so test before putting into production. Happy birthday release. Sponsored by: iXsystems Inc.
106 lines
3.8 KiB
Groff
106 lines
3.8 KiB
Groff
'\" t
|
|
.\" Title: ctdb-etcd
|
|
.\" Author:
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 11/20/2017
|
|
.\" Manual: CTDB - clustered TDB database
|
|
.\" Source: ctdb
|
|
.\" Language: English
|
|
.\"
|
|
.TH "CTDB\-ETCD" "7" "11/20/2017" "ctdb" "CTDB \- clustered TDB database"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
ctdb-etcd \- CTDB etcd integration
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBctdb_etcd_lock\fR\ 'u
|
|
\fBctdb_etcd_lock\fR
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
ctdb_etcd_lock is intended to be run as a mutex helper for CTDB\&. It will try to connect to an existing etcd cluster and grab a lock in that cluster to function as CTDB\*(Aqs recovery lock\&. Please see
|
|
\fIctdb/doc/cluster_mutex_helper\&.txt\fR
|
|
for details on the mutex helper API\&. To use this, include the following line in your CTDB config file:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
CTDB_RECOVERY_LOCK="!/usr/local/usr/libexec/ctdb/ctdb_etcd_lock"
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
You can also pass "\-v", "\-vv", or "\-vvv" to include verbose output in the CTDB log\&. Additional "v"s indicate increases in verbosity\&.
|
|
.PP
|
|
This mutex helper expects the system Python interpreter to have access to the etcd Python module\&. It also expects an etcd cluster to be configured and running\&. To integrate with this, there is an optional config file of the following format:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
key = value
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
The following configuration parameters (and their defaults) are defined for use by ctdb_etcd_lock:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
port = 2379 # connecting port for the etcd cluster
|
|
lock_ttl = 9 # seconds for TTL
|
|
refresh = 2 # seconds between attempts to maintain lock
|
|
locks_dir = _ctdb # where to store CTDB locks in etcd
|
|
# The final etcd directory for any given lock looks like:
|
|
# /_locks/{locks_dir}/{netbios name}/
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
In addition, any keyword parameter that can be used to configure an etcd client may be specified and modified here\&. For more documentation on these parameters, see here: https://github\&.com/jplana/python\-etcd/
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBctdb\fR(7),
|
|
\fBctdbd\fR(1),
|
|
\m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
|
|
.SH "AUTHOR"
|
|
.br
|
|
.PP
|
|
This documentation was written by Jose A\&. Rivera
|
|
.SH "COPYRIGHT"
|
|
.br
|
|
Copyright \(co 2016 Jose A. Rivera
|
|
.br
|
|
.PP
|
|
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version\&.
|
|
.PP
|
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
|
|
.PP
|
|
You should have received a copy of the GNU General Public License along with this program; if not, see
|
|
\m[blue]\fB\%http://www.gnu.org/licenses\fR\m[]\&.
|
|
.sp
|