From e115181ecb1e5d370b251351fef9ced480bc1666 Mon Sep 17 00:00:00 2001 From: neeraj pratap singh Date: Tue, 22 Aug 2023 13:32:58 +0530 Subject: [PATCH] doc: add the reject the clone when threads are not available feature in the document Fixes: https://tracker.ceph.com/issues/59714 Signed-off-by: Neeraj Pratap Singh (cherry picked from commit 6a44322d59e5542731dd450b383046a13bc28a66) --- PendingReleaseNotes | 9 +++++++++ doc/cephfs/fs-volumes.rst | 31 +++++++++++++++++++++++++------ 2 files changed, 34 insertions(+), 6 deletions(-) diff --git a/PendingReleaseNotes b/PendingReleaseNotes index e28c35efce5..801546c0b57 100644 --- a/PendingReleaseNotes +++ b/PendingReleaseNotes @@ -140,6 +140,15 @@ CephFS: Disallow delegating preallocated inode ranges to clients. Config isn't scalable. So we have removed the 'network_ping_times' section from the output. Details in the tracker: https://tracker.ceph.com/issues/57460 +* CephFS: The `subvolume snapshot clone` command now depends on the config option + `snapshot_clone_no_wait` which is used to reject the clone operation when + all the cloner threads are busy. This config option is enabled by default which means + that if no cloner threads are free, the clone request errors out with EAGAIN. + The value of the config option can be fetched by using: + `ceph config get mgr mgr/volumes/snapshot_clone_no_wait` + and it can be disabled by using: + `ceph config set mgr mgr/volumes/snapshot_clone_no_wait false` + >=18.0.0 * The RGW policy parser now rejects unknown principals by default. If you are diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst index 1e7adf3a03d..dc9be8379aa 100644 --- a/doc/cephfs/fs-volumes.rst +++ b/doc/cephfs/fs-volumes.rst @@ -579,6 +579,8 @@ To initiate a clone operation use: ceph fs subvolume snapshot clone +.. note:: ``subvolume snapshot clone`` command depends upon the above mentioned config option ``snapshot_clone_no_wait`` + If a snapshot (source subvolume) is a part of non-default group, the group name needs to be specified: .. prompt:: bash # @@ -597,12 +599,6 @@ Similar to specifying a pool layout when creating a subvolume, pool layout can b ceph fs subvolume snapshot clone --pool_layout -Configure the maximum number of concurrent clones. The default is 4: - -.. prompt:: bash # - - ceph config set mgr mgr/volumes/max_concurrent_clones - To check the status of a clone operation use: .. prompt:: bash # @@ -728,6 +724,29 @@ On successful cancellation, the cloned subvolume is moved to the ``canceled`` st .. note:: The canceled cloned may be deleted by supplying the ``--force`` option to the `fs subvolume rm` command. +Configurables +~~~~~~~~~~~~~ + +Configure the maximum number of concurrent clone operations. The default is 4: + +.. prompt:: bash # + + ceph config set mgr mgr/volumes/max_concurrent_clones + +Configure the snapshot_clone_no_wait option : + +.. prompt:: bash # + + ``snapshot_clone_no_wait`` config option is used to reject the clone creation request when the cloner threads + ( which can be configured using above option i.e. ``max_concurrent_clones``) are not available. + It is enabled by default i.e. the value set is True, whereas it can be configured by using below command. + + ceph config set mgr mgr/volumes/snapshot_clone_no_wait + + The current value of ``snapshot_clone_no_wait`` can be fetched by using below command. + + ceph config get mgr mgr/volumes/snapshot_clone_no_wait + .. _subvol-pinning: -- 2.39.5