From: Kotresh HR <khiremat@redhat.com>
Date: Wed, 6 Apr 2022 07:21:54 +0000 (+0530)
Subject: doc: Document the clone failure status
X-Git-Tag: v16.2.11~103^2~71^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=a7cfa393d5a393f20d1b207752bb31450f793f1b;p=ceph.git

doc: Document the clone failure status

Fixes: https://tracker.ceph.com/issues/55190
Signed-off-by: Kotresh HR <khiremat@redhat.com>
(cherry picked from commit 555d3610635f4206a21f7b41deabffdf2136ccbc)
---

diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst
index 6d59ab119b715..a84767946b3eb 100644
--- a/doc/cephfs/fs-volumes.rst
+++ b/doc/cephfs/fs-volumes.rst
@@ -323,8 +323,14 @@ A clone can be in one of the following states:
 #. `in-progress` : Clone operation is in progress
 #. `complete`    : Clone operation has successfully finished
 #. `failed`      : Clone operation has failed
+#. `canceled`    : Clone operation is cancelled by user
 
-Sample output from an `in-progress` clone operation::
+The reason for a clone failure is shown as below:
+
+#. `errno`     : error number
+#. `error_msg` : failure error string
+
+Sample output of an `in-progress` clone operation::
 
   $ ceph fs subvolume snapshot clone cephfs subvol1 snap1 clone1
   $ ceph fs clone status cephfs clone1
@@ -339,6 +345,28 @@ Sample output from an `in-progress` clone operation::
     }
   }
 
+.. note:: The `failure` section will be shown only if the clone is in failed or cancelled state
+
+Sample output of a `failed` clone operation::
+
+  $ ceph fs subvolume snapshot clone cephfs subvol1 snap1 clone1
+  $ ceph fs clone status cephfs clone1
+  {
+    "status": {
+      "state": "failed",
+      "source": {
+        "volume": "cephfs",
+        "subvolume": "subvol1",
+        "snapshot": "snap1"
+        "size": "104857600"
+      },
+      "failure": {
+        "errno": "122",
+        "errstr": "Disk quota exceeded"
+      }
+    }
+  }
+
 (NOTE: since `subvol1` is in default group, `source` section in `clone status` does not include group name)
 
 .. note:: Cloned subvolumes are accessible only after the clone operation has successfully completed.