Feature #37530

mgr/dashboard: Feature toggles

Added by Ernesto Puerta 3 months ago. Updated 11 days ago.

Target version:
Start date:
Due date:
% Done:


Affected Versions:
Pull request ID:



  • Provides support for disabling/enabling features from the Ceph-dashboard by means of configuration changes.
  • In this context features should be primarily considered from UI perspective and include at least:
    • Single components (e.g.: iSCSI)
    • Optionally: Sets of related components (e.g: RBD comprising Images, Mirroring & iSCSI). This could also be enabled/disabled on a per-component basis.
  • Takes precedence over Role Based Authorization: features are either enabled/disabled for all users.
  • No need for an instant effect: a Ceph-mgr or module reload could happen if needed. However, no code changes or builds should be needed.
  • No need to disable back-end functionality too.

User Stories

Feature toggles bring in benefits for a lots of user personas:

  • As a System Administrator I want to disable Ceph components I don't have deployed (e.g: iSCSI) so that the dashboard only reflects the relevant information and workflows.
  • As a Ceph Distributor, I want to disable Ceph elements I don't support (e.g.: CephFS).
  • As a Back-end Developer I want to disable a new experimental feature so that I don't break/interfere with other ongoing developments, or deployments.
  • As a UI/UX Designer I want disable an improved feature so that I can run an A/B test to quickly gather feedback from the same build.


Implementation tips

  • Ceph-mgr config options provide an easy (CLI) way to set/unset settings.
  • Options names can describe component hierarchies: RBD enables/disables RBD_IMAGES, RBD_MIRRORING, RBD_ISCSI.
  • For a front-end only feature toggle, there's a PR ongoing providing a SettingsService for accessing Ceph-Mgr Config Options.
  • For a back-end support, it should be easy to extend the ApiController/RESTController for enabling/disabling them.

Related issues

Related to mgr - Bug #38259: mgr/dashboard: replace pluggy lightweight implementation with packaged one New 02/11/2019


#1 Updated by Ernesto Puerta 3 months ago

Feedback from the F2F meeting:

Feature status indicators

- Features added to Ceph may not be supported by either SuSE or Redhat, so this discussion centers on how/if preview features should have some indicator in the UI to warn the admin.
- It's also important to ensure that if this path is adopted, each downstream vendor can select which features are viewed as not GA/supported
- Suse: support everything in the UI/CLI when it's shipped but no message is shown to indicate if something is Tech Preview
- Do we want to hide those elements?
- BlueStore, CephFS snapshots did have a warning that it was experimental - CLI emitted a warning
- "Allow experimental" setting to expose experimental features
- Do we similarly want to enable / disable other features (e.g. RGW, RBD, etc.)?
- Showing/hiding functionalities could be done via setting the user permission. The question is if the user permission can be applied to features that are declared as experimental
- If the permissions for a module are removed it means they are removed from the front-end and the REST API
- How granular would it be? E.g. a feature within RBD
- Extend and show experimental info in the About modal?

#2 Updated by Ernesto Puerta 3 months ago

  • Description updated (diff)

#3 Updated by Ernesto Puerta 3 months ago

  • Subject changed from Feature toggles to mgr/dashboard: Feature toggles

#4 Updated by Ernesto Puerta 2 months ago

  • Assignee changed from Kanika Murarka to Ernesto Puerta

#5 Updated by Ernesto Puerta 2 months ago

  • Status changed from New to In Progress

#6 Updated by Ernesto Puerta about 1 month ago

  • Pull request ID set to 25665

#7 Updated by Ernesto Puerta 17 days ago

  • Pull request ID changed from 25665 to 26102

#8 Updated by Ernesto Puerta 17 days ago

  • Status changed from In Progress to Need Review
  • % Done changed from 0 to 80

#9 Updated by Lenz Grimmer 11 days ago

  • Status changed from Need Review to Resolved

#10 Updated by Lenz Grimmer 11 days ago

  • Related to Bug #38259: mgr/dashboard: replace pluggy lightweight implementation with packaged one added

Also available in: Atom PDF