Removing dashboard from HORIZON_CONFIG doesn't work if it's in INSTALLED_APPS

[Gabriel Hurley]

The HORIZON_CONFIG "dashboards" setting needs to actively *remove* dashboards that are included in INSTALLED_APPS because the app loading mechanism causes the registration handler to happen regardless.

[Maxime Vidori (maxime-vidori)]

What is the meaning of actively remove? Do we have to add a controller which checks INSTALLED_APPS before the registration handler and removes modules from the tuple according to the dashboard attribute of HORIZON_CONFIG?

[Matthias Runge (mrunge)]

not sure, if HORIZON_CONFIG['dashboards'] is required anymore at all. I just set this to [] and horizon still seems to work for me as expected.

[David Lapsley (dlapsley)]

Just confirmed you don't. So, horizon.base iterates over INSTALLED_APPS and imports any module that has a 'dashboard' and/or 'panel' sub-module.

[David Lapsley (dlapsley)]

Hi Folks:

This is not actually a bug, but how the software was designed. The "dashboards" entry in HORIZON_CONFIG was only ever intended to be used in ordering dashboards. Here's the comment from Gabriel in horizon.base.

    def get_dashboards(self):
        """ Returns an ordered tuple of :class:`~horizon.Dashboard` modules.

        Orders dashboards according to the ``"dashboards"`` key in
        ``HORIZON_CONFIG`` or else returns all registered dashboards
        in alphabetical order.

        Any remaining :class:`~horizon.Dashboard` classes registered with
        Horizon but not listed in ``HORIZON_CONFIG['dashboards']``
        will be appended to the end of the list alphabetically.
        """

[Julie Pichon (jpichon)]

Thanks for looking into it David. Probably the documentation should be updated to make this clearer.

http://docs.openstack.org/developer/horizon/topics/settings.html#dashboards

[David Lapsley (dlapsley)]

Hi Julie: no problem! I'm happy to have a go at updating the documentation later this week when I have spare time (unless someone else would like to do it).

Cheers, David.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/72550

[David Lapsley (dlapsley)]

Hi Julie: I've updated the documentation for this setting and uploaded for review. Let me know if you'd like me to change anything.

Cheers, David.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/72550
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=368cf0da6aadb0ade9ad1a22bffc7885c6f854f0
Submitter: Jenkins
Branch: master

commit 368cf0da6aadb0ade9ad1a22bffc7885c6f854f0
Author: David Lapsley <email address hidden>
Date: Mon Feb 10 19:57:51 2014 -0800

    Update "dashboard" setting documentation

    Updates documentation for the Horizon "dashboard" setting.
    The option works as designed, but is incorrectly documented.

    Change-Id: I4d11528c25ef43f91977321055b3660d144b3c90
    Closes-Bug: 1056449