rgw: update the "radosgw-admin reshard status"

command documentation with expected output examples

Fixes: http://tracker.ceph.com/issues/37615
Signed-off-by: Mark Kogan <mkogan@redhat.com>

diff --git a/doc/radosgw/dynamicresharding.rst b/doc/radosgw/dynamicresharding.rst
index 5fb5063b76a93fb16e8ec400383714f0f93da60b..4d1061932ff398e118f30e11e3a9ca50c5cd7b71 100644 (file)
--- a/doc/radosgw/dynamicresharding.rst
+++ b/doc/radosgw/dynamicresharding.rst
@@ -85,6 +85,54 @@ Bucket resharding status
 
    # radosgw-admin reshard status --bucket <bucket_name>
 
+The output is a json array of 3 objects (reshard_status, new_bucket_instance_id, num_shards) per shard.
+
+For example, the output at different Dynamic Resharding stages is shown below:
+
+``1. Before resharding occurred:``
+::
+
+  [
+    {
+        "reshard_status": "CLS_RGW_RESHARD_NONE",
+        "new_bucket_instance_id": "",
+        "num_shards": -1
+    }
+  ]
+
+``2. During resharding:``
+::
+
+  [
+    {
+        "reshard_status": "CLS_RGW_RESHARD_IN_PROGRESS",
+        "new_bucket_instance_id": "1179f470-2ebf-4630-8ec3-c9922da887fd.8652.1",
+        "num_shards": 2
+    },
+    {
+        "reshard_status": "CLS_RGW_RESHARD_IN_PROGRESS",
+        "new_bucket_instance_id": "1179f470-2ebf-4630-8ec3-c9922da887fd.8652.1",
+        "num_shards": 2
+    }
+  ]
+
+``3, After resharding completed:``
+::
+
+  [
+    {
+        "reshard_status": "CLS_RGW_RESHARD_NONE",
+        "new_bucket_instance_id": "",
+        "num_shards": -1
+    },
+    {
+        "reshard_status": "CLS_RGW_RESHARD_NONE",
+        "new_bucket_instance_id": "",
+        "num_shards": -1
+    }
+  ]
+
+
 Cancel pending bucket resharding
 --------------------------------