RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2024-12-24 12:24:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
f6b24ece91
ceph/doc/mgr/dashboard_plugins/feature_toggles.inc.rst

47 lines
1.5 KiB
ReStructuredText
Raw Normal View History

doc: mgr/dashboard: feature-toggles: Add doc Fixes: http://tracker.ceph.com/issues/37530 Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2019-02-04 18:06:12 +00:00
.. _dashboard-feature-toggles:
Feature Toggles
^^^^^^^^^^^^^^^
doc: Updated Ceph Dashboard documentation Renamed "Ceph Manager Dashboard" to "Ceph Dashboard" in various locations, replaced "plugin" with "module". Overhauled the feature list, added more references to configuration instructions and related components. Fixed capitalization of subchapters. Added note about mixed content blocking to the Grafana section. Removed duplicate content from the dashboard's `README.rst`, moved some parts (supported browser list) into the documentation instead. Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2019-02-28 14:10:42 +00:00
This plug-in allows to enable or disable some features from the Ceph Dashboard
doc: mgr/dashboard: feature-toggles: Add doc Fixes: http://tracker.ceph.com/issues/37530 Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2019-02-04 18:06:12 +00:00
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).
mgr/dashboard: add feature toggle for NFS - New NFS feature toggle added. - Fixed regression which broke FeatureToggles in the main menu. - Added extensive unit testing to NavigationComponent - Added ng-mocks to improve test isolation and performance (~7x, 139s to 20s) - Added ng-bullet package to improve unit testing performance (2x, 20s to 9s) - Added Rxjs Schedulers to implement NgZone.runOutsideAngular in a Rxjs friendly way (based on https://stackoverflow.com/questions/43121400/run-ngrx-effect-outside-of-angulars-zone-to-prevent-timeout-in-protractor) Minor issues found from exhaustive unit testing: - Missing permissions in Cluster menu: - `permissions.log.read` and `permissions.prometheus.read` - Missing classes: - Block -> Images: `tc_submenuitem_block_images` - Block -> iSCSI: `tc_submenuitem_block_iscsi` - Typos: - class `tc_submenuitem_hosts` assigned to OSD menu (instead of `tc_submenuitem_osd`) - `tc_menuitem_cephs` -> `tc_menuitem_cephfs` Minor changes: - Previously, Cluster Map -> CRUSH Map required both OSD and Host permissions. Now it only requires OSD permissions (there are no references to hosts in CRUSH Map page). Nevertheless, all system roles setting OSD permission also set Host's, so no impact expected. - Previously, Cluster -> Monitoring menu was hidden when both Prometheus or Alertmanager weren't configured. Now it's displayed and when clicked on it shows the helper banner indicating that further configuration is required. This change removes the dependency on the PrometheusService. Fixes: https://tracker.ceph.com/issues/43419 Fixes: https://tracker.ceph.com/issues/43715 Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2020-03-04 20:31:50 +00:00
- **NFS**: ``nfs-ganesha`` exports.
doc: mgr/dashboard: feature-toggles: Add doc Fixes: http://tracker.ceph.com/issues/37530 Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2019-02-04 18:06:12 +00:00
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'
mgr/dashboard: add feature toggle for NFS - New NFS feature toggle added. - Fixed regression which broke FeatureToggles in the main menu. - Added extensive unit testing to NavigationComponent - Added ng-mocks to improve test isolation and performance (~7x, 139s to 20s) - Added ng-bullet package to improve unit testing performance (2x, 20s to 9s) - Added Rxjs Schedulers to implement NgZone.runOutsideAngular in a Rxjs friendly way (based on https://stackoverflow.com/questions/43121400/run-ngrx-effect-outside-of-angulars-zone-to-prevent-timeout-in-protractor) Minor issues found from exhaustive unit testing: - Missing permissions in Cluster menu: - `permissions.log.read` and `permissions.prometheus.read` - Missing classes: - Block -> Images: `tc_submenuitem_block_images` - Block -> iSCSI: `tc_submenuitem_block_iscsi` - Typos: - class `tc_submenuitem_hosts` assigned to OSD menu (instead of `tc_submenuitem_osd`) - `tc_menuitem_cephs` -> `tc_menuitem_cephfs` Minor changes: - Previously, Cluster Map -> CRUSH Map required both OSD and Host permissions. Now it only requires OSD permissions (there are no references to hosts in CRUSH Map page). Nevertheless, all system roles setting OSD permission also set Host's, so no impact expected. - Previously, Cluster -> Monitoring menu was hidden when both Prometheus or Alertmanager weren't configured. Now it's displayed and when clicked on it shows the helper banner indicating that further configuration is required. This change removes the dependency on the PrometheusService. Fixes: https://tracker.ceph.com/issues/43419 Fixes: https://tracker.ceph.com/issues/43715 Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2020-03-04 20:31:50 +00:00
Feature 'nfs': 'enabled'
doc: mgr/dashboard: feature-toggles: Add doc Fixes: http://tracker.ceph.com/issues/37530 Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2019-02-04 18:06:12 +00:00
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.
Reference in New Issue Copy Permalink