From 5ad6f16562aec7086ca6aefdfb88c1059eb0586d Mon Sep 17 00:00:00 2001 From: Ronen Friedman Date: Sun, 11 Feb 2024 19:32:19 +0200 Subject: [PATCH] doc/osd: update the documentation of several scrub-related options Signed-off-by: Ronen Friedman --- doc/glossary.rst | 2 +- doc/rados/configuration/osd-config-ref.rst | 2 ++ src/common/options/osd.yaml.in | 16 ++++++++++++---- 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/doc/glossary.rst b/doc/glossary.rst index 12e40f59c98..8c7dfe03ce8 100644 --- 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 06012120083..634690b88c0 100644 --- 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 2a7bad84e7b..598cf4f50fd 100644 --- 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 -- 2.39.5