aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthew Sakai <msakai@redhat.com>2024-03-07 16:02:35 -0500
committerMike Snitzer <snitzer@kernel.org>2024-03-07 19:56:24 -0500
commitcb824724dccb3195d22cad96e7b65fe13621d0a6 (patch)
treeacd4e24f60b9ebc4657e09b411c75b4afaa977ad
parent2a7f925bc25fc3591e6c7f2c1bd561004d744b6d (diff)
downloadlinux-dm-dm-vdo.tar.gz
dm vdo: document minimum metadata size requirementsfor-6.9/dm-vdodm-vdo
Signed-off-by: Matthew Sakai <msakai@redhat.com> Signed-off-by: Mike Snitzer <snitzer@kernel.org>
-rw-r--r--Documentation/admin-guide/device-mapper/vdo.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/admin-guide/device-mapper/vdo.rst b/Documentation/admin-guide/device-mapper/vdo.rst
index a3572582ead8f1..7e1ecafdf91e31 100644
--- a/Documentation/admin-guide/device-mapper/vdo.rst
+++ b/Documentation/admin-guide/device-mapper/vdo.rst
@@ -34,6 +34,17 @@ The repo also contains additional userspace tools which can be used to
inspect a vdo target's on-disk metadata. Fortunately, these tools are
rarely needed except by dm-vdo developers.
+Metadata requirements
+=====================
+
+Each vdo volume reserves 3GB of space for metadata, or more depending on
+its configuration. It is helpful to check that the space saved by
+deduplication and compression is not cancelled out by the metadata
+requirements. An estimation of the space saved for a specific dataset can
+be computed with the vdo estimator tool, which is available at:
+
+https://github.com/dm-vdo/vdoestimator/
+
Target interface
================