vblade-persistence.txt 2.4 KB

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