VBLADE/vblade-master/contrib/persistence/vblade-persistence.txt

   1
   2 = VBLADE-PERSISTENCE(5)
   3
   4 == NAME
   5
   6 vblade-persistence - description of the vblade persistence
   7
   8 == DESCRIPTION
   9
  10 vblade-persistence uses the files in `/etc/vblade.conf.d/` to manage
  11 exports. File names must end in `.conf`. The "instance" name is the
  12 file name without `.conf`.
  13
  14 The file format is a POSIX shell fragment.
  15
  16 The following variables *must* be defined: `netif`, `shelf`, `slot`,
  17 and `filename`. See vblade(8) for their meaning. Incomplete
  18 configuration files are ignored, so are files that are not a valid
  19 shell syntax.
  20
  21 Additionally, the following variables may be defined:
  22
  23 * `options`
  24
  25 Any options as provided by vblade(7).
  26
  27 * `ionice`
  28
  29 Use these to define an I/O scheduling class and level for that export.
  30 The value must be understood by ionice(1).
  31
  32
  33 == EXAMPLE
  34
  35 ----
  36     shelf=14
  37     slot=2
  38     netif=ens3
  39     filename=/dev/mapper/export
  40     options='-r -m 11:22:33:44:55:66,22:33:44:55:66:77 -o 8'
  41     ionice='--class best-effort --classdata 7'
  42 ----
  43
  44
  45 == USAGE
  46
  47 === On systems using systemd
  48
  49 Install `vblade-generator` in `/lib/systemd/system-generators/`, and
  50 both `vblade.service` and `vblade@.service` in `/lib/systemd/system/`.
  51 Enable the vblade service, reload systemd. Additional units for each
  52 export should appear, named `vblade@<instance>.service`.
  53
  54 === On systems using SysV init
  55
  56 Individual instances may be controlled by providing their name as
  57 a second option, e.g.
  58
  59 ----
  60     /etc/init.d/vblade status demo
  61 ----
  62
  63 Two different init scripts are available:
  64
  65 ==== `vblade.init.lsb-daemon`
  66
  67 Uses LSB functions and daemon(1) program to control the instance.
  68
  69 Pros: daemon(1) is a very fine tool for this, providing also respawning
  70 and output redirection.
  71
  72 ==== `vblade.init.daemon`
  73
  74 As above, but without using LSB functions.
  75
  76 Pros: Should be fairly portable, no thrills.
  77
  78 ==== Template
  79
  80 The template for these scripts is `vblade.init.in`, the actual
  81 templating is done using tpage(1p), see `vblade.init.generate`.
  82
  83 Support for using Debian's start-stop-daemon has been prepared but
  84 requires pid file supprt in vblade to be usable.
  85
  86
  87 == BUGS
  88
  89 On SysV init systems, the configuration files are always sourced as
  90 shell scripts. On systemd systems, the configuration file is just
  91 a key/value store without shell expansion.
  92
  93 It's a wise idea to run `sh -n` against a configuration file after any
  94 modification for basic format validation.
  95
  96
  97 == SEE ALSO
  98
  99 daemon: <http://www.libslack.org/daemon/>
 100
 101 tpage(1p)
 102
 103 vblade(8)
 104
 105 == AUTHOR
 106
 107 Christoph Biedl <sourceforge.bnwi@manchmal.in-ulm.de>