'\" t
.\"     Title: vblade-persistence
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "VBLADE\-PERSISTENCE" "5" "" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
vblade\-persistence \- description of the vblade persistence
.SH "DESCRIPTION"
.sp
vblade\-persistence uses the files in \f(CR/etc/vblade.conf.d/\fP to manage
exports. File names must end in \f(CR.conf\fP. The "instance" name is the
file name without \f(CR.conf\fP.
.sp
The file format is a POSIX shell fragment.
.sp
The following variables \fBmust\fP be defined: \f(CRnetif\fP, \f(CRshelf\fP, \f(CRslot\fP,
and \f(CRfilename\fP. See vblade(8) for their meaning. Incomplete
configuration files are ignored, so are files that are not a valid
shell syntax.
.sp
Additionally, the following variables may be defined:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CRoptions\fP
.RE
.sp
Any options as provided by vblade(7).
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CRionice\fP
.RE
.sp
Use these to define an I/O scheduling class and level for that export.
The value must be understood by ionice(1).
.SH "EXAMPLE"
.sp
.if n .RS 4
.nf
    shelf=14
    slot=2
    netif=ens3
    filename=/dev/mapper/export
    options=\(aq\-r \-m 11:22:33:44:55:66,22:33:44:55:66:77 \-o 8\(aq
    ionice=\(aq\-\-class best\-effort \-\-classdata 7\(aq
.fi
.if n .RE
.SH "USAGE"
.SS "On systems using systemd"
.sp
Install \f(CRvblade\-generator\fP in \f(CR/lib/systemd/system\-generators/\fP, and
both \f(CRvblade.service\fP and \f(CRvblade@.service\fP in \f(CR/lib/systemd/system/\fP.
Enable the vblade service, reload systemd. Additional units for each
export should appear, named \f(CRvblade@<instance>.service\fP.
.SS "On systems using SysV init"
.sp
Individual instances may be controlled by providing their name as
a second option, e.g.
.sp
.if n .RS 4
.nf
    /etc/init.d/vblade status demo
.fi
.if n .RE
.sp
Two different init scripts are available:
.SS "\f(CRvblade.init.lsb\-daemon\fP"
.sp
Uses LSB functions and daemon(1) program to control the instance.
.sp
Pros: daemon(1) is a very fine tool for this, providing also respawning
and output redirection.
.SS "\f(CRvblade.init.daemon\fP"
.sp
As above, but without using LSB functions.
.sp
Pros: Should be fairly portable, no thrills.
.SS "Template"
.sp
The template for these scripts is \f(CRvblade.init.in\fP, the actual
templating is done using tpage(1p), see \f(CRvblade.init.generate\fP.
.sp
Support for using Debian\(cqs start\-stop\-daemon has been prepared but
requires pid file supprt in vblade to be usable.
.SH "BUGS"
.sp
On SysV init systems, the configuration files are always sourced as
shell scripts. On systemd systems, the configuration file is just
a key/value store without shell expansion.
.sp
It\(cqs a wise idea to run \f(CRsh \-n\fP against a configuration file after any
modification for basic format validation.
.SH "SEE ALSO"
.sp
daemon: \c
.URL "http://www.libslack.org/daemon/" "" ""
.sp
tpage(1p)
.sp
vblade(8)
.SH "AUTHOR"
.sp
Christoph Biedl <\c
.MTO "sourceforge.bnwi\(atmanchmal.in\-ulm.de" "" ">"