]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr/dashboard_plugins: edit feature_toggles.inc.rst 63705/head
authorZac Dover <zac.dover@proton.me>
Sun, 1 Jun 2025 23:04:25 +0000 (09:04 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 3 Jun 2025 20:52:21 +0000 (06:52 +1000)
Follow up on the suggestions made by Anthony D'Atri in
https://github.com/ceph/ceph/pull/63367.

- Add "nvmeof" to the list of enabled features.
- Remove an extraneous space.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 6117c4eff3721a995612329cf51c25968371d48d)

doc/mgr/dashboard_plugins/feature_toggles.inc.rst

index 2360afad316c62f0ad733a72c7b150fddeed307e..e1990ec2e8659e790dfcba024dc0d63408f25c81 100644 (file)
@@ -6,12 +6,15 @@ Feature Toggles
 This plug-in allows to enable or disable some features from the Ceph Dashboard
 on-demand. When a feature becomes disabled:
 
-- Its front-end elements (web pages, menu entries, charts, etc.) will become hidden.
-- Its associated REST API endpoints will reject any further requests (404, Not Found Error).
+- Its front-end elements (web pages, menu entries, charts, etc.) will become
+  hidden.
+- Its associated REST API endpoints will reject any further requests (404, Not
+  Found Error).
 
-The main purpose of this plug-in is to allow ad-hoc customizations of the workflows exposed
-by the dashboard. Additionally, it could allow for dynamically enabling experimental
-features with minimal configuration burden and no service impact.
+The main purpose of this plug-in is to allow ad hoc customizations of the
+workflows exposed by the dashboard. Additionally, it could allow for dynamically
+enabling experimental features with minimal configuration burden and no service
+impact.
 
 The list of features that can be enabled/disabled is:
 
@@ -35,6 +38,7 @@ To retrieve a list of features and their current statuses:
 
     Feature 'cephfs': 'enabled'
     Feature 'iscsi': 'enabled'
+    Feature 'nvmeof': 'enabled'
     Feature 'mirroring': 'enabled'
     Feature 'rbd': 'enabled'
     Feature 'rgw': 'enabled'
@@ -52,5 +56,5 @@ To enable or disable the status of a single or multiple features:
    Feature 'mirroring': disabled
 
 After a feature status has changed, the API REST endpoints immediately respond
-to that change, but it make take up to twenty (20) seconds  for the front-end
-UI elements seconds to reflect the change.
+to that change, but it may take up to twenty (20) seconds for the front-end UI
+elements seconds to reflect the change.