doc: Add doc and PendingRealeaseNotes

Add help about new list_unfound fields in troubleshooting-pg.rst Add info in PendingReleaseNotes Signed-off-by: David Zafman <[email protected]>
areed · Sep 16, 2020 · bb50580 · bb50580
1 parent 5b0ba0e
commit bb50580
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 16 deletions.
diff --git a/PendingReleaseNotes b/PendingReleaseNotes
@@ -160,3 +160,7 @@
 
 * fs: "fs authorize" now sets MON cap to "allow <perm> fsname=<fsname>"
       instead of setting it to "allow r" all the time.
+
+* ``ceph pg #.# list_unfound`` output has been enhanced to provide
+  might_have_unfound information which indicates which OSDs may
+  contain the unfound objects.
diff --git a/doc/rados/troubleshooting/troubleshooting-pg.rst b/doc/rados/troubleshooting/troubleshooting-pg.rst
@@ -215,28 +215,55 @@ First, you can identify which objects are unfound with::
 
 .. code-block:: javascript
 
- { "offset": { "oid": "",
-      "key": "",
-      "snapid": 0,
-      "hash": 0,
-      "max": 0},
-  "num_missing": 0,
-  "num_unfound": 0,
-  "objects": [
-     { "oid": "object 1",
-       "key": "",
-       "hash": 0,
-       "max": 0 },
-     ...
-  ],
-  "more": 0}
+  {
+    "num_missing": 1,
+    "num_unfound": 1,
+    "objects": [
+        {
+            "oid": {
+                "oid": "object",
+                "key": "",
+                "snapid": -2,
+                "hash": 2249616407,
+                "max": 0,
+                "pool": 2,
+                "namespace": ""
+            },
+            "need": "43'251",
+            "have": "0'0",
+            "flags": "none",
+            "clean_regions": "clean_offsets: [], clean_omap: 0, new_object: 1",
+            "locations": [
+                "0(3)",
+                "4(2)"
+            ]
+        }
+    ],
+    "state": "NotRecovering",
+    "available_might_have_unfound": true,
+    "might_have_unfound": [
+        {
+            "osd": "2(4)",
+            "status": "osd is down"
+        }
+    ],
+    "more": false
+  }
 
 If there are too many objects to list in a single result, the ``more``
 field will be true and you can query for more.  (Eventually the
 command line tool will hide this from you, but not yet.)
 
 Second, you can identify which OSDs have been probed or might contain
-data::
+data.
+
+At the end of the listing (before ``more`` is false), ``might_have_unfound`` is provided
+when ``available_might_have_unfound`` is true.  This is equivalent to the output
+of ``ceph pg #.# query``.  This eliminates the need to use ``query`` directly.
+The ``might_have_unfound`` information given behaves the same way as described below for ``query``.
+The only difference is that OSDs that have ``already probed`` status are ignored.
+
+Use of ``query``::
 
 	ceph pg 2.4 query