Pluggable Panels and Groups¶

ADD_EXCEPTIONS¶

A dictionary of exception classes to be added to HORIZON['exceptions'].

ADD_INSTALLED_APPS¶

A list of applications to be prepended to INSTALLED_APPS. This is needed to expose static files from a plugin.

ADD_ANGULAR_MODULES¶

A list of AngularJS modules to be loaded when Angular bootstraps. These modules are added as dependencies on the root Horizon application horizon.

ADD_JS_FILES¶

A list of javascript source files to be included in the compressed set of files that are loaded on every page. This is needed for AngularJS modules that are referenced in ADD_ANGULAR_MODULES and therefore need to be included in every page.

ADD_JS_SPEC_FILES¶

A list of javascript spec files to include for integration with the Jasmine spec runner. Jasmine is a behavior-driven development framework for testing JavaScript code.

ADD_SCSS_FILES¶

A list of scss files to be included in the compressed set of files that are loaded on every page. We recommend one scss file per dashboard, use @import if you need to include additional scss files for panels.

AUTO_DISCOVER_STATIC_FILES¶

If set to True, JavaScript files and static angular html template files will be automatically discovered from the static folder in each apps listed in ADD_INSTALLED_APPS.

JavaScript source files will be ordered based on naming convention: files with extension .module.js listed first, followed by other JavaScript source files.

JavaScript files for testing will also be ordered based on naming convention: files with extension .mock.js listed first, followed by files with extension .spec.js.

If ADD_JS_FILES and/or ADD_JS_SPEC_FILES are also specified, files manually listed there will be appended to the auto-discovered files.

DISABLED¶

If set to True, this settings file will not be added to the settings.

UPDATE_HORIZON_CONFIG¶

A dictionary of values that will replace the values in HORIZON_CONFIG.

DASHBOARD¶

The slug of the dashboard to be added to HORIZON['dashboards']. Required.

DEFAULT¶

If set to True, this dashboard will be set as the default dashboard.

Examples¶

To disable a dashboard locally, create a file openstack_dashboard/local/enabled/_40_dashboard-name.py with the following content:

DASHBOARD = '<dashboard-name>'
DISABLED = True

To add a Tuskar-UI (Infrastructure) dashboard, you have to install it, and then create a file openstack_dashboard/local/enabled/_50_tuskar.py with:

from tuskar_ui import exceptions

DASHBOARD = 'infrastructure'
ADD_INSTALLED_APPS = [
    'tuskar_ui.infrastructure',
]
ADD_EXCEPTIONS = {
    'recoverable': exceptions.RECOVERABLE,
    'not_found': exceptions.NOT_FOUND,
    'unauthorized': exceptions.UNAUTHORIZED,
}

PANEL¶

The slug of the panel to be added to HORIZON_CONFIG. Required.

PANEL_DASHBOARD¶

The slug of the dashboard the PANEL associated with. Required.

PANEL_GROUP¶

The slug of the panel group the PANEL is associated with. If you want the panel to show up without a panel group, use the panel group “default”.

DEFAULT_PANEL¶

If set, it will update the default panel of the PANEL_DASHBOARD.

ADD_PANEL¶

Python panel class of the PANEL to be added.

REMOVE_PANEL¶

If set to True, the PANEL will be removed from PANEL_DASHBOARD/PANEL_GROUP.

Examples¶

To add a new panel to the Admin panel group in Admin dashboard, create a file openstack_dashboard/local/enabled/_60_admin_add_panel.py with the following content:

PANEL = 'plugin_panel'
PANEL_DASHBOARD = 'admin'
PANEL_GROUP = 'admin'
ADD_PANEL = 'test_panels.plugin_panel.panel.PluginPanel'

To remove Info panel from Admin panel group in Admin dashboard locally, create a file openstack_dashboard/local/enabled/_70_admin_remove_panel.py with the following content:

PANEL = 'info'
PANEL_DASHBOARD = 'admin'
PANEL_GROUP = 'admin'
REMOVE_PANEL = True

To change the default panel of Admin dashboard to Instances panel, create a file openstack_dashboard/local/enabled/_80_admin_default_panel.py with the following content:

PANEL = 'instances'
PANEL_DASHBOARD = 'admin'
PANEL_GROUP = 'admin'
DEFAULT_PANEL = 'instances'

PANEL_GROUP¶

The slug of the panel group to be added to HORIZON_CONFIG. Required.

PANEL_GROUP_NAME¶

The display name of the PANEL_GROUP. Required.

PANEL_GROUP_DASHBOARD¶

The slug of the dashboard the PANEL_GROUP associated with. Required.

Examples¶

To add a new panel group to the Admin dashboard, create a file openstack_dashboard/local/enabled/_90_admin_add_panel_group.py with the following content:

PANEL_GROUP = 'plugin_panel_group'
PANEL_GROUP_NAME = 'Plugin Panel Group'
PANEL_GROUP_DASHBOARD = 'admin'