doc/ceph-volume create a migration section to help users coming from ceph-disk

Signed-off-by: Alfredo Deza <adeza@redhat.com>
(cherry picked from commit e433efe51481ec63bc9753a0f446fe2b12b5bb6a)

diff --git a/doc/ceph-volume/index.rst b/doc/ceph-volume/index.rst
index 216597b13e357415fd2744703ffa5446efffe524..5cf4778bbe104dd83c76d7c5ea326704912b5ca2 100644 (file)
--- a/doc/ceph-volume/index.rst
+++ b/doc/ceph-volume/index.rst
@@ -17,6 +17,33 @@ that may have been deployed with ``ceph-disk``.
 * :ref:`ceph-volume-lvm`
 * :ref:`ceph-volume-simple`
 
+
+Migrating
+---------
+Starting on Ceph version 12.2.2, ``ceph-disk`` is deprecated. Deprecation
+warnings will show up that will link to this page. It is strongly suggested
+that users start consuming ``ceph-volume``.
+
+New deployments
+^^^^^^^^^^^^^^^
+For new deployments, :ref:`ceph-volume-lvm` is recommended, it can use any
+logical volume as input for data OSDs, or it can setup a minimal/naive logical
+volume from a device.
+
+Existing OSDs
+^^^^^^^^^^^^^
+If the cluster has OSDs that were provisioned with ``ceph-disk``, then
+``ceph-volume`` can take over the management of these with
+:ref:`ceph-volume-simple`. A scan is done on the data device or OSD directory,
+and ``ceph-disk`` is fully disabled.
+
+Encrypted OSDs
+^^^^^^^^^^^^^^
+If using encryption with OSDs, there is currently no support in ``ceph-volume``
+for this scenario (although support for this is coming soon). In this case, it
+is OK to continue to use ``ceph-disk`` until ``ceph-volume`` fully supports it.
+This page will be updated when that happens.
+
 .. toctree::
    :hidden:
    :maxdepth: 3