From 4a66819da48cee430ca74830e1a6f63685b6b240 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Tue, 28 Mar 2023 06:48:32 +1000 Subject: [PATCH] doc/glossary: add "Scrubbing" Add "Scrubbing" to the glossary. Co-authored-by: Anthony D'Atri Signed-off-by: Zac Dover --- doc/glossary.rst | 22 ++++++++++++++++++++++ doc/rados/configuration/osd-config-ref.rst | 2 ++ 2 files changed, 24 insertions(+) diff --git a/doc/glossary.rst b/doc/glossary.rst index fa98dda2f41b8..fbfa9af833c6a 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -373,6 +373,28 @@ provides a gateway to both the Amazon S3 RESTful API and the OpenStack Swift API. + scrubs + + The processes by which Ceph ensures data integrity. During the + process of scrubbing, Ceph generates a catalog of all objects + in a placement group, then ensures that none of the objects are + missing or mismatched by comparing each primary object against + its replicas, which are stored across other OSDs. Any PG + is determined to have a copy of an object that is different + than the other copies or is missing entirely is marked + "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", + 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 + reads the data and uses checksums to ensure data integrity. + + See :ref:`Scrubbing ` in the RADOS OSD + Configuration Reference Guide and page 141 of *Mastering Ceph, + second edition* (Fisk, Nick. 2019). + secrets Secrets are credentials used to perform digital authentication whenever privileged users must access systems that require diff --git a/doc/rados/configuration/osd-config-ref.rst b/doc/rados/configuration/osd-config-ref.rst index 8590c588704bf..deffd6103f32e 100644 --- a/doc/rados/configuration/osd-config-ref.rst +++ b/doc/rados/configuration/osd-config-ref.rst @@ -140,6 +140,8 @@ See `Pool & PG Config Reference`_ for details. .. index:: OSD; scrubbing +.. _rados_config_scrubbing: + Scrubbing ========= -- 2.39.5