From: David Zafman <dzafman@redhat.com>
Date: Tue, 22 Jan 2019 02:20:20 +0000 (-0800)
Subject: common: Fix some configuration descriptions
X-Git-Tag: v13.2.5~14^2~2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=c95dcdb021bdae20e952a9a112f0eed91e80af22;p=ceph.git

common: Fix some configuration descriptions

osd_scrub_backoff_ratio
osd_deep_scrub_randomize_ratio

Signed-off-by: David Zafman <dzafman@redhat.com>
(cherry picked from commit aa4fc197858bfd94924c09aada1c408c8ef01273)
---

diff --git a/src/common/options.cc b/src/common/options.cc
index 532411ee0f8f..8bf2f24830cb 100644
--- a/src/common/options.cc
+++ b/src/common/options.cc
@@ -3041,7 +3041,8 @@ std::vector<Option> get_global_options() {
 
     Option("osd_scrub_backoff_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
     .set_default(.66)
-    .set_description("Backoff ratio after a failed scrub scheduling attempt"),
+    .set_long_description("This is the precentage of ticks that do NOT schedule scrubs, 66% means that 1 out of 3 ticks will schedule scrubs")
+    .set_description("Backoff ratio for scheduling scrubs"),
 
     Option("osd_scrub_chunk_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
     .set_default(5)
@@ -3076,9 +3077,8 @@ std::vector<Option> get_global_options() {
 
     Option("osd_deep_scrub_randomize_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
     .set_default(0.15)
-    .set_description("Ratio of deep scrub interval to randomly vary")
-    .set_long_description("This prevents a deep scrub 'stampede' by randomly varying the scrub intervals so that they are soon uniformly distributed over the week")
-    .add_see_also("osd_deep_scrub_interval"),
+    .set_description("Scrubs will randomly become deep scrubs at this rate (0.15 -> 15% of scrubs are deep)")
+    .set_long_description("This prevents a deep scrub 'stampede' by spreading deep scrubs so they are uniformly distributed over the week"),
 
     Option("osd_deep_scrub_stride", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
     .set_default(512_K)