From d315dfbdd87c8f5e0470aca9ad5dcdcdf510dacf Mon Sep 17 00:00:00 2001 From: Kotresh HR Date: Wed, 6 Apr 2022 12:51:54 +0530 Subject: [PATCH] doc: Document the clone failure status Fixes: https://tracker.ceph.com/issues/55190 Signed-off-by: Kotresh HR (cherry picked from commit 555d3610635f4206a21f7b41deabffdf2136ccbc) --- doc/cephfs/fs-volumes.rst | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst index 6ef08a2e9c395..d029a47c2284f 100644 --- a/doc/cephfs/fs-volumes.rst +++ b/doc/cephfs/fs-volumes.rst @@ -340,8 +340,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 @@ -356,6 +362,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. -- 2.39.5