updated Readme for ceph-volume
Change-Id: I4385ef332d200440094385c170f7bc9af7a74b39
Related-Prod: PROD-29287
diff --git a/README.rst b/README.rst
index a0c3d3c..0f846fb 100644
--- a/README.rst
+++ b/README.rst
@@ -838,6 +838,52 @@
number sets number of incremental backups to be run, before a full backup
is performed.
+ Enabling ceph-volume
+ ----------------------------
+ This feature is tech preview.
+
+ You can set the formula to use ceph-volume utility.
+ The ceph-volume utility is a replacement for ceph-disk, which is deprecated since the Ceph Mimic release.
+
+ To enable ceph-volume, set ``osd.lvm_enabled`` to ``True``:
+
+ .. code-block:: yaml
+
+ ceph:
+ osd:
+ lvm_enabled: True
+
+ Partitioning for block_db and WAL
+ ----------------------------
+
+ You can allow the formula to automatically partition a disk used as block DB or WAL.
+
+ .. code-block:: yaml
+
+ ceph:
+ osd:
+ backend:
+ bluestore:
+ create_partitions: true
+
+ A partition on DB and WAL devices will be created based on the Ceph OSD definition from the cluster model with sizes defined in
+ ``bluestore_block_db_size`` and ``bluestore_block_wal_size``. For example, the following configuration will create three
+ partitions on a VDD device with size of 10 GB:
+ .. code-block:: yaml
+
+ ceph:
+ osd:
+ backend:
+ bluestore:
+ bluestore_block_db_size: 10737418240
+ disks:
+ - dev: /dev/vdc1
+ block_db: /dev/vdd
+ - dev: /dev/vdc2
+ block_db: /dev/vdd
+ - dev: /dev/vdc3
+ block_db: /dev/vdd
+
Migration from Decapod to salt-formula-ceph
--------------------------------------------