]> git.proxmox.com Git - ceph.git/blame - ceph/doc/ceph-volume/index.rst
update sources to 12.2.10
[ceph.git] / ceph / doc / ceph-volume / index.rst
CommitLineData
b5b8bbf5
FG
1.. _ceph-volume:
2
3ceph-volume
4===========
5Deploy OSDs with different device technologies like lvm or physical disks using
3efd9988
FG
6pluggable tools (:doc:`lvm/index` itself is treated like a plugin) and trying to
7follow a predictable, and robust way of preparing, activating, and starting OSDs.
b5b8bbf5
FG
8
9:ref:`Overview <ceph-volume-overview>` |
10:ref:`Plugin Guide <ceph-volume-plugins>` |
11
12
13**Command Line Subcommands**
91327a77 14
3efd9988
FG
15There is currently support for ``lvm``, and plain disks (with GPT partitions)
16that may have been deployed with ``ceph-disk``.
b5b8bbf5
FG
17
18* :ref:`ceph-volume-lvm`
3efd9988
FG
19* :ref:`ceph-volume-simple`
20
91327a77
AA
21**Node inventory**
22
23The :ref:`ceph-volume-inventory` subcommand provides information and metadata
24about a nodes physical disk inventory.
25
3efd9988
FG
26
27Migrating
28---------
1adf2230 29Starting on Ceph version 13.0.0, ``ceph-disk`` is deprecated. Deprecation
3efd9988 30warnings will show up that will link to this page. It is strongly suggested
28e407b8
AA
31that 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`
3efd9988
FG
38
39New deployments
40^^^^^^^^^^^^^^^
41For new deployments, :ref:`ceph-volume-lvm` is recommended, it can use any
42logical volume as input for data OSDs, or it can setup a minimal/naive logical
43volume from a device.
44
45Existing OSDs
46^^^^^^^^^^^^^
47If the cluster has OSDs that were provisioned with ``ceph-disk``, then
48``ceph-volume`` can take over the management of these with
49:ref:`ceph-volume-simple`. A scan is done on the data device or OSD directory,
b32b8144 50and ``ceph-disk`` is fully disabled. Encryption is fully supported.
3efd9988 51
b5b8bbf5
FG
52
53.. toctree::
54 :hidden:
55 :maxdepth: 3
56 :caption: Contents:
57
58 intro
3efd9988 59 systemd
91327a77 60 inventory
b5b8bbf5
FG
61 lvm/index
62 lvm/activate
1adf2230 63 lvm/batch
b32b8144 64 lvm/encryption
b5b8bbf5
FG
65 lvm/prepare
66 lvm/scan
67 lvm/systemd
3efd9988
FG
68 lvm/list
69 lvm/zap
70 simple/index
71 simple/activate
72 simple/scan
73 simple/systemd