doc/rbd: documented 'rbd compression hint' config option

Signed-off-by: Jason Dillaman <dillaman@redhat.com>

diff --git a/doc/rbd/rbd-config-ref.rst b/doc/rbd/rbd-config-ref.rst
index 40e318e1512210d127d7834898f01bb42fcd07b0..a68f446e6eeacd242eb0776d20bc7c4b78b99d4f 100644 (file)
--- a/doc/rbd/rbd-config-ref.rst
+++ b/doc/rbd/rbd-config-ref.rst
@@ -4,6 +4,17 @@
 
 See `Block Device`_ for additional details.
 
+Generic IO Settings
+===================
+
+``rbd compression hint``
+
+:Description: Hint to send to the OSDs on write operations. If set to `compressible` and the OSD `bluestore compression mode` setting is `passive`, the OSD will attempt to compress the data. If set to `incompressible` and the OSD compression setting is `aggressive`, the OSD will not attempt to compress the data.
+:Type: Enum
+:Required: No
+:Default: ``none``
+:Values: ``none``, ``compressible``, ``incompressible``
+
 Cache Settings
 =======================