From 9fd4b062f1a22de61c37457a32d0d7cefc0e8fcf Mon Sep 17 00:00:00 2001
From: David Zafman <dzafman@redhat.com>
Date: Fri, 22 Mar 2019 16:47:23 -0700
Subject: [PATCH] doc: Fix the pg states and auto repair config options

Fixes: http://tracker.ceph.com/issues/38896

Signed-off-by: David Zafman <dzafman@redhat.com>
---
 doc/dev/placement-group.rst                | 69 ++++++++++++++++------
 doc/rados/configuration/osd-config-ref.rst | 16 +++++
 2 files changed, 67 insertions(+), 18 deletions(-)

diff --git a/doc/dev/placement-group.rst b/doc/dev/placement-group.rst
index ac58c984db0..2994752f04b 100644
--- a/doc/dev/placement-group.rst
+++ b/doc/dev/placement-group.rst
@@ -97,8 +97,17 @@ User-visible PG States
 *down*
   a replica with necessary data is down, so the pg is offline
 
-*replay*
-  the PG is waiting for clients to replay operations after an OSD crashed
+*recovery_unfound*
+  recovery could not finish because object(s) are unfound.
+
+*backfill_unfound*
+  backfill could not finish because object(s) are unfound.
+
+*premerge*
+  the PG is in a quiesced-IO state due to an impending PG merge.  That
+  happens when pg_num_pending < pg_num, and applies to the PGs with
+  pg_num_pending <= ps < pg_num as well as the corresponding peer PG
+  that it is merging with.
 
 *scrubbing*
   the PG is being checked for inconsistencies
@@ -120,20 +129,9 @@ User-visible PG States
 *recovering*
   objects are being migrated/synchronized with replicas
 
-*recovery_wait*
-  the PG is waiting for the local/remote recovery reservations
-
-*backfilling*
-  a special case of recovery, in which the entire contents of
-  the PG are scanned and synchronized, instead of inferring what
-  needs to be transferred from the PG logs of recent operations
-
 *backfill_wait*
   the PG is waiting in line to start backfill
 
-*backfill_toofull*
-  backfill reservation rejected, OSD too full
-
 *incomplete*
   a pg is missing a necessary period of history from its
   log.  If you see this state, report a bug, and try to start any
@@ -147,11 +145,46 @@ User-visible PG States
   the PG is temporarily mapped to a different set of OSDs from what
   CRUSH specified
 
-*premerge*
-  the PG is in a quiesced-IO state due to an impending PG merge.  That
-  happens when pg_num_pending < pg_num, and applies to the PGs with
-  pg_num_pending <= ps < pg_num as well as the corresponding peer PG
-  that it is merging with.
+*deep*
+  In conjunction with *scrubbing* the scrub is a deep scrub
+
+*backfilling*
+  a special case of recovery, in which the entire contents of
+  the PG are scanned and synchronized, instead of inferring what
+  needs to be transferred from the PG logs of recent operations
+
+*backfill_toofull*
+  backfill reservation rejected, OSD too full
+
+*recovery_wait*
+  the PG is waiting for the local/remote recovery reservations
+
+*undersized*
+  the PG can't select enough OSDs given its size
+
+*activating*
+  the PG is peered but not yet active
+
+*peered*
+  the PG peered but can't go active
+
+*snaptrim*
+  the PG is trimming snaps
+
+*snaptrim_wait*
+  the PG is queued to trim snaps
+
+*recovery_toofull*
+  recovery reservation rejected, OSD too full
+
+*snaptrim_error*
+  the PG could not complete snap trimming due to errors
+
+*forced_recovery*
+  the PG has been marked for highest priority recovery
+
+*forced_backfill*
+  the PG has been marked for highest priority backfill
 
 
 OMAP STATISTICS
diff --git a/doc/rados/configuration/osd-config-ref.rst b/doc/rados/configuration/osd-config-ref.rst
index 6ff7bda6cbc..937c8b848a3 100644
--- a/doc/rados/configuration/osd-config-ref.rst
+++ b/doc/rados/configuration/osd-config-ref.rst
@@ -358,6 +358,22 @@ scrubbing operations.
 :Default: 512 KB. ``524288``
 
 
+``osd scrub auto repair``
+
+:Description: Setting this to ``true`` will enable automatic pg repair when errors
+              are found in deep-scrub.  However, if more than ``osd scrub auto repair num errors``
+              errors are found a repair is NOT performed.
+:Type: Boolean
+:Default: ``false``
+
+
+``osd scrub auto repair num errors``
+
+:Description: Auto repair will not occur if more than this many errors are found.
+:Type: 32-bit Integer
+:Default: ``5``
+
+
 .. index:: OSD; operations settings
 
 Operations