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 ``zfs`` support is available for running a FreeBSD cluster.
  19
  20 * :ref:`ceph-volume-lvm`
  21 * :ref:`ceph-volume-simple`
  22 * :ref:`ceph-volume-zfs`
  23
  24 **Node inventory**
  25
  26 The :ref:`ceph-volume-inventory` subcommand provides information and metadata
  27 about a nodes physical disk inventory.
  28
  29
  30 Migrating
  31 ---------
  32 Starting on Ceph version 13.0.0, ``ceph-disk`` is deprecated. Deprecation
  33 warnings will show up that will link to this page. It is strongly suggested
  34 that users start consuming ``ceph-volume``. There are two paths for migrating:
  35
  36 #. Keep OSDs deployed with ``ceph-disk``: The :ref:`ceph-volume-simple` command
  37    provides a way to take over the management while disabling ``ceph-disk``
  38    triggers.
  39 #. Redeploy existing OSDs with ``ceph-volume``: This is covered in depth on
  40    :ref:`rados-replacing-an-osd`
  41
  42 For details on why ``ceph-disk`` was removed please see the :ref:`Why was
  43 ceph-disk replaced? <ceph-disk-replaced>` section.
  44
  45
  46 New deployments
  47 ^^^^^^^^^^^^^^^
  48 For new deployments, :ref:`ceph-volume-lvm` is recommended, it can use any
  49 logical volume as input for data OSDs, or it can setup a minimal/naive logical
  50 volume from a device.
  51
  52 Existing OSDs
  53 ^^^^^^^^^^^^^
  54 If the cluster has OSDs that were provisioned with ``ceph-disk``, then
  55 ``ceph-volume`` can take over the management of these with
  56 :ref:`ceph-volume-simple`. A scan is done on the data device or OSD directory,
  57 and ``ceph-disk`` is fully disabled. Encryption is fully supported.
  58
  59
  60 .. toctree::
  61    :hidden:
  62    :maxdepth: 3
  63    :caption: Contents:
  64
  65    intro
  66    systemd
  67    inventory
  68    lvm/index
  69    lvm/activate
  70    lvm/batch
  71    lvm/encryption
  72    lvm/prepare
  73    lvm/create
  74    lvm/scan
  75    lvm/systemd
  76    lvm/list
  77    lvm/zap
  78    simple/index
  79    simple/activate
  80    simple/scan
  81    simple/systemd
  82    zfs/index
  83    zfs/inventory