From: Rishabh Dave <ridave@redhat.com>
Date: Fri, 28 Jun 2024 05:45:44 +0000 (+0530)
Subject: doc/cephfs: add release notes and docs for clone progress report
X-Git-Tag: v20.0.0~1215^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=645cc6e6a8342a8625670b981955d7b9d5590837;p=ceph.git

doc/cephfs: add release notes and docs for clone progress report

Update docs and add release notes about the progress report that is
printed in output of "ceph fs clone status" command and progress bars
that is/are printed in output of "ceph status" command.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
---

diff --git a/PendingReleaseNotes b/PendingReleaseNotes
index a306c6d563ae..cb34a4d08921 100644
--- a/PendingReleaseNotes
+++ b/PendingReleaseNotes
@@ -236,6 +236,15 @@ CephFS: Disallow delegating preallocated inode ranges to clients. Config
   exposed via the new `--snap-id` option for `rbd clone` command.
 * RBD: The output of `rbd snap ls --all` command now includes the original
   type for trashed snapshots.
+* CephFS: "ceph fs clone status" command will now print statistics about clone
+  progress in terms of how much data has been cloned (in both percentage as
+  well as bytes) and how many files have been cloned.
+* CephFS: "ceph status" command will now print a progress bar when cloning is
+  ongoing. If clone jobs are more than the cloner threads, it will print one
+  more progress bar that shows total amount of progress made by both ongoing
+  as well as pending clones. Both progress are accompanied by messages that
+  show number of clone jobs in the respective categories and the amount of
+  progress made by each of them.
 
 >=18.0.0
 
diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst
index 381e02190ebc..c37e31dda2eb 100644
--- a/doc/cephfs/fs-volumes.rst
+++ b/doc/cephfs/fs-volumes.rst
@@ -758,16 +758,40 @@ Here is an example of an ``in-progress`` clone:
 ::
 
     {
-        "status": {
-            "state": "in-progress",
-            "source": {
-                "volume": "cephfs",
-                "subvolume": "subvol1",
-                "snapshot": "snap1"
-            }
+      "status": {
+        "state": "in-progress",
+        "source": {
+          "volume": "cephfs",
+          "subvolume": "subvol1",
+          "snapshot": "snap1"
+        },
+        "progress_report": {
+          "percentage cloned": "12.24%",
+          "amount cloned": "376M/3.0G",
+          "files cloned": "4/6"
         }
+      }
     }
 
+A progress report is also printed in the output when clone is ``in-progress``.
+Here the progress is reported only for the specific clone. For collective
+progress made by all ongoing clones, a progress bar is printed at the bottom
+in ouput of ``ceph status`` command::
+
+  progress:
+    3 ongoing clones - average progress is 47.569% (10s)
+      [=============...............] (remaining: 11s)
+
+If the number of clone jobs are more than cloner threads, two progress bars
+are printed, one for ongoing clones (same as above) and other for all
+(ongoing+pending) clones::
+
+  progress:
+    4 ongoing clones - average progress is 27.669% (15s)
+      [=======.....................] (remaining: 41s)
+    Total 5 clones - average progress is 41.667% (3s)
+      [===========.................] (remaining: 4s)
+
 .. note:: The ``failure`` section will be shown only if the clone's state is ``failed`` or ``cancelled``
 
 Here is an example of a ``failed`` clone: