summaryrefslogtreecommitdiffstats
path: root/src/ceph/doc/man/8/ceph-volume-systemd.rst
blob: 1a7b481befaa0f91fea398e04d6d54829e7d1c22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
:orphan:

=======================================================
 ceph-volume-systemd -- systemd ceph-volume helper tool
=======================================================

.. program:: ceph-volume-systemd

Synopsis
========

| **ceph-volume-systemd** *systemd instance name*


Description
===========
:program:`ceph-volume-systemd` is a systemd helper tool that receives input
from (dynamically created) systemd units so that activation of OSDs can
proceed.

It translates the input into a system call to ceph-volume for activation
purposes only.


Examples
========
Its input is the ``systemd instance name`` (represented by ``%i`` in a systemd
unit), and it should be in the following format::

    <ceph-volume subcommand>-<extra metadata>

In the case of ``lvm`` a call could look like::

    /usr/bin/ceph-volume-systemd lvm-0-8715BEB4-15C5-49DE-BA6F-401086EC7B41

Which in turn will call ``ceph-volume`` in the following way::

    ceph-volume lvm trigger  0-8715BEB4-15C5-49DE-BA6F-401086EC7B41

Any other subcommand will need to have implemented a ``trigger`` command that
can consume the extra metadata in this format.


Availability
============

:program:`ceph-volume-systemd` is part of Ceph, a massively scalable,
open-source, distributed storage system. Please refer to the documentation at
http://docs.ceph.com/ for more information.


See also
========

:doc:`ceph-osd <ceph-osd>`\(8),
:doc:`ceph-disk <ceph-volume>`\(8),