src/ceph/doc/man/8/ceph-volume-systemd.rst

   1 :orphan:
   2
   3 =======================================================
   4  ceph-volume-systemd -- systemd ceph-volume helper tool
   5 =======================================================
   6
   7 .. program:: ceph-volume-systemd
   8
   9 Synopsis
  10 ========
  11
  12 | **ceph-volume-systemd** *systemd instance name*
  13
  14
  15 Description
  16 ===========
  17 :program:`ceph-volume-systemd` is a systemd helper tool that receives input
  18 from (dynamically created) systemd units so that activation of OSDs can
  19 proceed.
  20
  21 It translates the input into a system call to ceph-volume for activation
  22 purposes only.
  23
  24
  25 Examples
  26 ========
  27 Its input is the ``systemd instance name`` (represented by ``%i`` in a systemd
  28 unit), and it should be in the following format::
  29
  30     <ceph-volume subcommand>-<extra metadata>
  31
  32 In the case of ``lvm`` a call could look like::
  33
  34     /usr/bin/ceph-volume-systemd lvm-0-8715BEB4-15C5-49DE-BA6F-401086EC7B41
  35
  36 Which in turn will call ``ceph-volume`` in the following way::
  37
  38     ceph-volume lvm trigger  0-8715BEB4-15C5-49DE-BA6F-401086EC7B41
  39
  40 Any other subcommand will need to have implemented a ``trigger`` command that
  41 can consume the extra metadata in this format.
  42
  43
  44 Availability
  45 ============
  46
  47 :program:`ceph-volume-systemd` is part of Ceph, a massively scalable,
  48 open-source, distributed storage system. Please refer to the documentation at
  49 http://docs.ceph.com/ for more information.
  50
  51
  52 See also
  53 ========
  54
  55 :doc:`ceph-osd <ceph-osd>`\(8),
  56 :doc:`ceph-disk <ceph-volume>`\(8),