doc/osd: update the documentation of several scrub-related options

Signed-off-by: Ronen Friedman <rfriedma@redhat.com>

diff --git a/doc/glossary.rst b/doc/glossary.rst
index 12e40f59c98b5d31c13d096a0ad7d8ec27aa2c32..8c7dfe03ce80620a4a4595c1395605c3db2477cb 100644 (file)
--- a/doc/glossary.rst
+++ b/doc/glossary.rst
@@ -422,7 +422,7 @@
                 "inconsistent" (that is, the PG is marked "inconsistent"). 
 
                 There are two kinds of scrubbing: light scrubbing and deep
-                scrubbing (also called "normal scrubbing" and "deep scrubbing",
+                scrubbing (also called "shallow scrubbing" and "deep scrubbing",
                 respectively). Light scrubbing is performed daily and does
                 nothing more than confirm that a given object exists and that
                 its metadata is correct. Deep scrubbing is performed weekly and

diff --git a/doc/rados/configuration/osd-config-ref.rst b/doc/rados/configuration/osd-config-ref.rst
index 0601212008383f0ec0f3841df84178788c438938..634690b88c064500a474fafb325d9b3c8e8c792e 100644 (file)
--- a/doc/rados/configuration/osd-config-ref.rst
+++ b/doc/rados/configuration/osd-config-ref.rst
@@ -171,7 +171,9 @@ increase or decrease the frequency and depth of scrubbing operations.
 .. confval:: osd_scrub_min_interval
 .. confval:: osd_scrub_max_interval
 .. confval:: osd_scrub_chunk_min
+.. confval:: osd_shallow_scrub_chunk_min
 .. confval:: osd_scrub_chunk_max
+.. confval:: osd_shallow_scrub_chunk_max
 .. confval:: osd_scrub_sleep
 .. confval:: osd_deep_scrub_interval
 .. confval:: osd_scrub_interval_randomize_ratio

diff --git a/src/common/options/osd.yaml.in b/src/common/options/osd.yaml.in
index 2a7bad84e7b1b59edf8671394fd91e340b3be0b0..598cf4f50fd0a254e46f2f3fd07dad7d902442a5 100644 (file)
--- a/src/common/options/osd.yaml.in
+++ b/src/common/options/osd.yaml.in
@@ -381,9 +381,11 @@ options:
 - name: osd_scrub_sleep
   type: float
   level: advanced
-  desc: Duration to inject a delay during scrubbing
-  fmt_desc: Time to sleep before scrubbing the next group of chunks (seconds). Increasing this value will slow
-    down the overall rate of scrubbing so that client operations will be less impacted.
+  desc: Duration (in seconds) of delay injected between chunks when scrubbing
+  fmt_desc: Sleep time in seconds before scrubbing the next group of objects (the next chunk).
+    Increasing this value will slow down the overall rate of scrubbing, reducing scrub
+    impact on client operations.
+    This setting is ignored when the mClock scheduler is used.
   default: 0
   flags:
   - runtime
@@ -392,7 +394,13 @@ options:
 - name: osd_scrub_extended_sleep
   type: float
   level: advanced
-  desc: Duration to inject a delay during scrubbing out of scrubbing hours (seconds)
+  desc: Duration (in seconds) of delay injected between chunks when scrubbing out
+    of scrubbing hours
+  fmt_desc: Sleep time in seconds before scrubbing the next group of objects (the next chunk).
+    This configuration value is used for scrubbing out of scrubbing hours.
+    Increasing this value will slow down the overall rate of scrubbing, reducing scrub
+    impact on client operations.
+    This setting is ignored when the mClock scheduler is used.
   default: 0
   see_also:
   - osd_scrub_begin_hour