From 10fa01d075b09726e3f07d2cae83ced4e418deae Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Fri, 6 Jan 2023 22:51:47 +1000 Subject: [PATCH] doc/man: define --num-rep, --min-rep and --max-rep Explain the "--num-rep", "--min-rep", and "--max-rep" options, which are required when running "crushtool" commands with the "--show-mappings" flag. Originally reported by Brad Fitzpatrick. https://tracker.ceph.com/issues/58374 Signed-off-by: Zac Dover --- doc/man/8/crushtool.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/man/8/crushtool.rst b/doc/man/8/crushtool.rst index 80c25ca2653..4c848659655 100644 --- a/doc/man/8/crushtool.rst +++ b/doc/man/8/crushtool.rst @@ -108,6 +108,16 @@ pools; it only runs simulations by mapping values in the range shows that value **24** is mapped to devices **[11,6]** by rule **1**. + One of the following is required when using the ``--show-mappings`` option: + + (a) ``--num-rep`` + (b) both ``--min-rep`` and ``--max-rep`` + + ``--num-rep`` stands for "number of replicas, indicates the number of + replicas in a pool, and is used to specify an exact number of replicas (for + example ``--num-rep 5``). ``--min-rep`` and ``--max-rep`` are used together + to specify a range of replicas (for example, ``--min-rep 1 --max-rep 10``). + .. option:: --show-bad-mappings Displays which value failed to be mapped to the required number of -- 2.39.5