ceph/doc/ceph-volume/index.rst

   1 .. _ceph-volume:
   2
   3 ceph-volume
   4 ===========
   5 Deploy OSDs with different device technologies like lvm or physical disks using
   6 pluggable tools (:doc:`lvm/index` itself is treated like a plugin) and trying to
   7 follow a predictable, and robust way of preparing, activating, and starting OSDs.
   8
   9 :ref:`Overview <ceph-volume-overview>` |
  10 :ref:`Plugin Guide <ceph-volume-plugins>` |
  11
  12
  13 **Command Line Subcommands**
  14
  15 There is currently support for ``lvm``, and plain disks (with GPT partitions)
  16 that may have been deployed with ``ceph-disk``.
  17
  18 * :ref:`ceph-volume-lvm`
  19 * :ref:`ceph-volume-simple`
  20
  21 **Node inventory**
  22
  23 The :ref:`ceph-volume-inventory` subcommand provides information and metadata
  24 about a nodes physical disk inventory.
  25
  26
  27 Migrating
  28 ---------
  29 Starting on Ceph version 13.0.0, ``ceph-disk`` is deprecated. Deprecation
  30 warnings will show up that will link to this page. It is strongly suggested
  31 that users start consuming ``ceph-volume``. There are two paths for migrating:
  32
  33 #. Keep OSDs deployed with ``ceph-disk``: The :ref:`ceph-volume-simple` command
  34    provides a way to take over the management while disabling ``ceph-disk``
  35    triggers.
  36 #. Redeploy existing OSDs with ``ceph-volume``: This is covered in depth on
  37    :ref:`rados-replacing-an-osd`
  38
  39 For details on why ``ceph-disk`` was removed please see the :ref:`Why was
  40 ceph-disk replaced? <ceph-disk-replaced>` section.
  41
  42
  43 New deployments
  44 ^^^^^^^^^^^^^^^
  45 For new deployments, :ref:`ceph-volume-lvm` is recommended, it can use any
  46 logical volume as input for data OSDs, or it can setup a minimal/naive logical
  47 volume from a device.
  48
  49 Existing OSDs
  50 ^^^^^^^^^^^^^
  51 If the cluster has OSDs that were provisioned with ``ceph-disk``, then
  52 ``ceph-volume`` can take over the management of these with
  53 :ref:`ceph-volume-simple`. A scan is done on the data device or OSD directory,
  54 and ``ceph-disk`` is fully disabled. Encryption is fully supported.
  55
  56
  57 .. toctree::
  58    :hidden:
  59    :maxdepth: 3
  60    :caption: Contents:
  61
  62    intro
  63    systemd
  64    inventory
  65    lvm/index
  66    lvm/activate
  67    lvm/batch
  68    lvm/encryption
  69    lvm/prepare
  70    lvm/create
  71    lvm/scan
  72    lvm/systemd
  73    lvm/list
  74    lvm/zap
  75    simple/index
  76    simple/activate
  77    simple/scan
  78    simple/systemd