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

   1 :orphan:
   2
   3 ========================================
   4  ceph-volume -- Ceph OSD deployment tool
   5 ========================================
   6
   7 .. program:: ceph-volume
   8
   9 Synopsis
  10 ========
  11
  12 | **ceph-volume** [-h] [--cluster CLUSTER] [--log-level LOG_LEVEL]
  13 |                 [--log-path LOG_PATH]
  14
  15 | **ceph-volume** **lvm** [ *trigger* | *create* | *activate* | *prepare* ]
  16
  17 Description
  18 ===========
  19
  20 :program:`ceph-volume` is a single purpose command line tool to deploy logical
  21 volumes as OSDs, trying to maintain a similar API to ``ceph-disk`` when
  22 preparing, activating, and creating OSDs.
  23
  24 It deviates from ``ceph-disk`` by not interacting or relying on the udev rules
  25 that come installed for Ceph. These rules allow automatic detection of
  26 previously setup devices that are in turn fed into ``ceph-disk`` to activate
  27 them.
  28
  29
  30 Commands
  31 ========
  32
  33 lvm
  34 ---
  35
  36 By making use of LVM tags, the ``lvm`` sub-command is able to store and later
  37 re-discover and query devices associated with OSDs so that they can later
  38 activated.
  39
  40 Subcommands:
  41
  42 **activate**
  43 Enables a systemd unit that persists the OSD ID and its UUID (also called
  44 ``fsid`` in Ceph CLI tools), so that at boot time it can understand what OSD is
  45 enabled and needs to be mounted.
  46
  47 Usage::
  48
  49     ceph-volume lvm activate --filestore <osd id> <osd fsid>
  50
  51 Optional Arguments:
  52
  53 * [-h, --help]  show the help message and exit
  54 * [--bluestore] filestore objectstore (not yet implemented)
  55 * [--filestore] filestore objectstore (current default)
  56
  57
  58 **prepare**
  59 Prepares a logical volume to be used as an OSD and journal using a ``filestore`` setup
  60 (``bluestore`` support is planned). It will not create or modify the logical volumes
  61 except for adding extra metadata.
  62
  63 Usage::
  64
  65     ceph-volume lvm prepare --filestore --data <data lv> --journal <journal device>
  66
  67 Optional arguments:
  68
  69 * [-h, --help]          show the help message and exit
  70 * [--journal JOURNAL]   A logical group name, path to a logical volume, or path to a device
  71 * [--journal-size GB]   Size (in GB) A logical group name or a path to a logical volume
  72 * [--bluestore]         Use the bluestore objectstore (not currently supported)
  73 * [--filestore]         Use the filestore objectstore (currently the only supported object store)
  74 * [--osd-id OSD_ID]     Reuse an existing OSD id
  75 * [--osd-fsid OSD_FSID] Reuse an existing OSD fsid
  76
  77 Required arguments:
  78
  79 * --data                A logical group name or a path to a logical volume
  80
  81 **create**
  82 Wraps the two-step process to provision a new osd (calling ``prepare`` first
  83 and then ``activate``) into a single one. The reason to prefer ``prepare`` and
  84 then ``activate`` is to gradually introduce new OSDs into a cluster, and
  85 avoiding large amounts of data being rebalanced.
  86
  87 The single-call process unifies exactly what ``prepare`` and ``activate`` do,
  88 with the convenience of doing it all at once. Flags and general usage are
  89 equivalent to those of the ``prepare`` subcommand.
  90
  91 **trigger**
  92 This subcommand is not meant to be used directly, and it is used by systemd so
  93 that it proxies input to ``ceph-volume lvm activate`` by parsing the
  94 input from systemd, detecting the UUID and ID associated with an OSD.
  95
  96 Usage::
  97
  98     ceph-volume lvm trigger <SYSTEMD-DATA>
  99
 100 The systemd "data" is expected to be in the format of::
 101
 102     <OSD ID>-<OSD UUID>
 103
 104 The lvs associated with the OSD need to have been prepared previously,
 105 so that all needed tags and metadata exist.
 106
 107 Positional arguments:
 108
 109 * <SYSTEMD_DATA>  Data from a systemd unit containing ID and UUID of the OSD.
 110
 111 Availability
 112 ============
 113
 114 :program:`ceph-volume` is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
 115 the documentation at http://docs.ceph.com/ for more information.
 116
 117
 118 See also
 119 ========
 120
 121 :doc:`ceph-osd <ceph-osd>`\(8),
 122 :doc:`ceph-disk <ceph-disk>`\(8),