From 19fcec84d8d7d21e796c7624e521b60d28ee21ed Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 20:45:59 +0200 Subject: Adding upstream version 16.2.11+ds. Signed-off-by: Daniel Baumann --- doc/mgr/dashboard_plugins/debug.inc.rst | 43 +++++++++++++++++ doc/mgr/dashboard_plugins/feature_toggles.inc.rst | 56 +++++++++++++++++++++++ doc/mgr/dashboard_plugins/motd.inc.rst | 36 +++++++++++++++ 3 files changed, 135 insertions(+) create mode 100644 doc/mgr/dashboard_plugins/debug.inc.rst create mode 100644 doc/mgr/dashboard_plugins/feature_toggles.inc.rst create mode 100644 doc/mgr/dashboard_plugins/motd.inc.rst (limited to 'doc/mgr/dashboard_plugins') diff --git a/doc/mgr/dashboard_plugins/debug.inc.rst b/doc/mgr/dashboard_plugins/debug.inc.rst new file mode 100644 index 000000000..883419cbf --- /dev/null +++ b/doc/mgr/dashboard_plugins/debug.inc.rst @@ -0,0 +1,43 @@ +.. _dashboard-debug: + +Debug +^^^^^ + +This plugin allows to customize the behaviour of the dashboard according to the +debug mode. It can be enabled, disabled or checked with the following command: + +.. prompt:: bash $ + + ceph dashboard debug status + +:: + + Debug: 'disabled' + +.. prompt:: bash $ + + ceph dashboard debug enable + +:: + + Debug: 'enabled' + +.. prompt:: bash $ + + ceph dashboard debug disable + +:: + + Debug: 'disabled' + +By default, it's disabled. This is the recommended setting for production +deployments. If required, debug mode can be enabled without need of restarting. +Currently, disabled debug mode equals to CherryPy ``production`` environment, +while when enabled, it uses ``test_suite`` defaults (please refer to +`CherryPy Environments +`_ for more +details). + +It also adds request uuid (``unique_id``) to Cherrypy on versions that don't +support this. It additionally prints the ``unique_id`` to error responses and +log messages. diff --git a/doc/mgr/dashboard_plugins/feature_toggles.inc.rst b/doc/mgr/dashboard_plugins/feature_toggles.inc.rst new file mode 100644 index 000000000..7c96b0faa --- /dev/null +++ b/doc/mgr/dashboard_plugins/feature_toggles.inc.rst @@ -0,0 +1,56 @@ +.. _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). +- **NFS**: ``nfs-ganesha`` exports. + +By default all features come enabled. + +To retrieve a list of features and their current statuses: + +.. prompt:: bash $ + + ceph dashboard feature status + +:: + + Feature 'cephfs': 'enabled' + Feature 'iscsi': 'enabled' + Feature 'mirroring': 'enabled' + Feature 'rbd': 'enabled' + Feature 'rgw': 'enabled' + Feature 'nfs': 'enabled' + +To enable or disable the status of a single or multiple features: + +.. prompt:: bash $ + + 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. diff --git a/doc/mgr/dashboard_plugins/motd.inc.rst b/doc/mgr/dashboard_plugins/motd.inc.rst new file mode 100644 index 000000000..0f9cc199a --- /dev/null +++ b/doc/mgr/dashboard_plugins/motd.inc.rst @@ -0,0 +1,36 @@ +.. _dashboard-motd: + +Message of the day (MOTD) +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Displays a configured `message of the day` at the top of the Ceph Dashboard. + +The importance of a MOTD can be configured by its severity, which is +`info`, `warning` or `danger`. The MOTD can expire after a given time, +this means it will not be displayed in the UI anymore. Use the following +syntax to specify the expiration time: `Ns|m|h|d|w` for seconds, minutes, +hours, days and weeks. If the MOTD should expire after 2 hours, use `2h` +or `5w` for 5 weeks. Use `0` to configure a MOTD that does not expire. + +To configure a MOTD, run the following command: + +.. prompt:: bash $ + + ceph dashboard motd set + +To show the configured MOTD: + +.. prompt:: bash $ + + ceph dashboard motd get + +To clear the configured MOTD run: + +.. prompt:: bash $ + + ceph dashboard motd clear + +A MOTD with a `info` or `warning` severity can be closed by the user. The +`info` MOTD is not displayed anymore until the local storage cookies are +cleared or a new MOTD with a different severity is displayed. A MOTD with +a 'warning' severity will be displayed again in a new session. -- cgit v1.2.3