mirror of
https://github.com/ceph/ceph
synced 2024-12-18 17:37:38 +00:00
ae8e288769
Add '*.inc.rst' to the list of excluded patterns from sphinx-build. This allows for using '*.inc.rst' as includes, and avoids duplicates. The benefit of keeping the trailing '.rst' extension is that most IDEs use that to render reStructured Text files. Fixes: http://tracker.ceph.com/issues/37530 Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
45 lines
1.5 KiB
ReStructuredText
45 lines
1.5 KiB
ReStructuredText
.. _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.
|