From a8b819da71804868d83bd9775c41ede39b1b65a7 Mon Sep 17 00:00:00 2001 From: Nikhilkumar Shelke Date: Thu, 5 May 2022 13:31:24 +0530 Subject: [PATCH] docs: display in-progress clones for a snapshot If any clone is in pending or in-progress state then show these clones in 'fs subvolume snapshot info' command output. This field only exists if clones are in pending or in progress state. Fixes: https://tracker.ceph.com/issues/55041 Signed-off-by: Nikhilkumar Shelke --- doc/cephfs/fs-volumes.rst | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst index 2add5769f05..c3b5b1390cb 100644 --- a/doc/cephfs/fs-volumes.rst +++ b/doc/cephfs/fs-volumes.rst @@ -344,6 +344,39 @@ The output format is json and contains fields as follows. * created_at: time of creation of snapshot in the format "YYYY-MM-DD HH:MM:SS:ffffff" * data_pool: data pool the snapshot belongs to * has_pending_clones: "yes" if snapshot clone is in progress otherwise "no" +* pending_clones: list of in progress or pending clones and their target group if exist otherwise this field is not shown +* orphan_clones_count: count of orphan clones if snapshot has orphan clones otherwise this field is not shown + +Sample output if snapshot clones are in progress or pending state:: + + $ ceph fs subvolume snapshot info cephfs subvol snap + { + "created_at": "2022-06-14 13:54:58.618769", + "data_pool": "cephfs.cephfs.data", + "has_pending_clones": "yes", + "pending_clones": [ + { + "name": "clone_1", + "target_group": "target_subvol_group" + }, + { + "name": "clone_2" + }, + { + "name": "clone_3", + "target_group": "target_subvol_group" + } + ] + } + +Sample output if no snapshot clone is in progress or pending state:: + + $ ceph fs subvolume snapshot info cephfs subvol snap + { + "created_at": "2022-06-14 13:54:58.618769", + "data_pool": "cephfs.cephfs.data", + "has_pending_clones": "no" + } Set custom metadata on the snapshot as a key-value pair using:: -- 2.39.5