diff options
| author | Rishabh Dave <ridave@redhat.com> | 2024-07-28 19:28:49 +0200 |
|---|---|---|
| committer | Rishabh Dave <ridave@redhat.com> | 2024-10-19 13:27:16 +0200 |
| commit | 373910de34fc9e1d98218aed0361cd9bf3badffa (patch) | |
| tree | 5aa50d1947ca4780c5eba6be4d4397c05c18bfcf | |
| parent | qa/cephfs: test enable/disable of volumes plugin (diff) | |
| download | ceph-373910de34fc9e1d98218aed0361cd9bf3badffa.tar.xz ceph-373910de34fc9e1d98218aed0361cd9bf3badffa.zip | |
doc/cephfs: add doc for disabling mgr/volumes plugin
Signed-off-by: Rishabh Dave <ridave@redhat.com>
| -rw-r--r-- | doc/cephfs/fs-volumes.rst | 23 | ||||
| -rw-r--r-- | doc/cephfs/troubleshooting.rst | 5 |
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/cephfs/fs-volumes.rst b/doc/cephfs/fs-volumes.rst index 4a5b5232738..34cb7917d1b 100644 --- a/doc/cephfs/fs-volumes.rst +++ b/doc/cephfs/fs-volumes.rst @@ -1419,5 +1419,28 @@ set with this id was present in the database $ ceph fs quiesce fs1 sub1 sub2 sub3 --set-id="external-id" --if-version=0 + +.. _disabling-volumes-plugin: + +Disabling Volumes Plugin +------------------------ +By default the volumes plugin is enabled and set to ``always on``. However, in +certain cases it might be appropriate to disable it. For example, when a CephFS +is in a degraded state, the volumes plugin commands may accumulate in MGR +instead of getting served. Which eventually causes policy throttles to kick in +and the MGR becomes unresponsive. + +In this event, volumes plugin can be disabled even though it is an +``always on`` module in MGR. To do so, run ``ceph mgr module disable volumes +--yes-i-really-mean-it``. Do note that this command will disable operations +and remove commands of volumes plugin since it will disable all CephFS +services on the Ceph cluster accessed through this plugin. + +Before resorting to a measure as drastic as this, it is a good idea to try less +drastic measures and then assess if the file system experience has improved due +to it. One example of such less drastic measure is to disable asynchronous +threads launched by volumes plugins for cloning and purging trash. + + .. _manila: https://github.com/openstack/manila .. _CSI: https://github.com/ceph/ceph-csi diff --git a/doc/cephfs/troubleshooting.rst b/doc/cephfs/troubleshooting.rst index 78d0a8f54d3..582daa10338 100644 --- a/doc/cephfs/troubleshooting.rst +++ b/doc/cephfs/troubleshooting.rst @@ -412,6 +412,11 @@ its associated key. A less drastic but half-fix is to change the osd cap for your user to just ``caps osd = "allow rw"`` and delete ``tag cephfs data=....`` +Disabling Volumes Plugin +======================== +In certain scenarios, volumes plugin might be needed to disabled to prevent compromise +for rest of the Ceph cluster. For details see: :ref:`disabling-volumes-plugin` + Reporting Issues ================ |