From: Ernesto Puerta <epuertat@redhat.com>
Date: Mon, 4 Feb 2019 18:06:12 +0000 (+0100)
Subject: doc: mgr/dashboard: feature-toggles: Add doc
X-Git-Tag: v14.1.0~165^2~4
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=7b06daedfc09110575c2d32a67d17af5dcb666e9;p=ceph.git

doc: mgr/dashboard: feature-toggles: Add doc

Fixes: http://tracker.ceph.com/issues/37530
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
---

diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst
index 8e0b86ac74e3..6172558b18ec 100644
--- a/doc/mgr/dashboard.rst
+++ b/doc/mgr/dashboard.rst
@@ -74,7 +74,7 @@ various aspects of your Ceph cluster:
   modification. Copy or clone snapshots, flatten cloned images.
 * **RBD mirroring**: Enable and configure RBD mirroring to a remote Ceph server.
   Lists all active sync daemons and their status, pools and RBD images including
-  their synchronization state. 
+  their synchronization state.
 * **CephFS**: Lists all active filesystem clients and associated pools,
   including their usage statistics.
 * **Object Gateway**: Lists all active object gateways and their performance
@@ -313,16 +313,16 @@ mgr/prometheus/>`_ of the prometheus module.
 
 #. Add the Dashboards to Grafana:
 
-   Dashboards can be added to Grafana by importing dashboard jsons. 
+   Dashboards can be added to Grafana by importing dashboard jsons.
    Following command can be used for downloading json files::
-	
+
 	wget https://raw.githubusercontent.com/ceph/ceph/master/monitoring/grafana/dashboards/<Dashboard-name>.json
 
    You can find all the dashboard jsons `here <https://github.com/ceph/ceph/tree/
    master/monitoring/grafana/dashboards>`_ .
 
    For Example, for ceph-cluster overview you can use::
-	
+
         wget https://raw.githubusercontent.com/ceph/ceph/master/monitoring/grafana/dashboards/ceph-cluster.json
 
 #. Configure Grafana in `/etc/grafana/grafana.ini` to adapt anonymous mode::
@@ -762,3 +762,11 @@ NFS-Ganesha cluster.
 When configuring the Ceph Dashboard with multiple NFS-Ganesha clusters, the
 Web UI will automatically allow to choose to which cluster an export belongs.
 
+
+Plug-ins
+--------
+
+Dashboard Plug-ins allow to extend the functionality of the dashboard in a modular
+and loosely coupled approach.
+
+.. include:: dashboard_plugins/feature_toggles.rst.inc
diff --git a/doc/mgr/dashboard_plugins/feature_toggles.rst.inc b/doc/mgr/dashboard_plugins/feature_toggles.rst.inc
new file mode 100644
index 000000000000..bb12aaad09f1
--- /dev/null
+++ b/doc/mgr/dashboard_plugins/feature_toggles.rst.inc
@@ -0,0 +1,44 @@
+.. _dashboard-feature-toggles:
+
+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).
+
+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:
+
+- **Block (RBD)**:
+   - Image Management: ``rbd``
+   - Mirroring: ``mirroring``
+   - iSCSI: ``iscsi``
+- **Filesystem (Cephfs)**: ``cephfs``
+- **Objects (RGW)**: ``rgw`` (including daemon, user and bucket management).
+
+By default all features come enabled.
+
+To retrieve a list of features and their current statuses::
+
+  $ ceph dashboard feature status
+  Feature 'cephfs': 'enabled'
+  Feature 'iscsi': 'enabled'
+  Feature 'mirroring': 'enabled'
+  Feature 'rbd': 'enabled'
+  Feature 'rgw': 'enabled'
+
+To enable or disable the status of a single or multiple features::
+
+  $ ceph dashboard feature disable iscsi mirroring
+  Feature 'iscsi': disabled
+  Feature 'mirroring': disabled
+
+After a feature status has changed, the API REST endpoints immediately respond to
+that change, while for the front-end UI elements, it may take up to 20 seconds to
+reflect it.