OpenStack Dashboard (Horizon)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Mark McLoughlin b67f21f9b4 Final versioning for 2012.1.3 6 years ago
docs Added "network" to the list of required nova services. 7 years ago
horizon Final versioning for 2012.1.3 6 years ago
openstack_dashboard Fixed validation check for ICMP rules 6 years ago
tools Use glance stable/essex rather than master 6 years ago
.bzrignore Re-architects the OpenStack Dashboard for modularity and extensibility. 7 years ago
.gitignore Makes actually list it's dependencies for pip/easy_install. 7 years ago
.gitreview Set defaultbranch in .gitreview to stable/essex 6 years ago
.mailmap Add distribute to test-requires. 7 years ago
.pylintrc updating to mimic other openstack projects, pep8, pylint, coverage 7 years ago
AUTHORS Use glance stable/essex rather than master 6 years ago
LICENSE Initial commit 8 years ago Add missing docs files in tarball 7 years ago
Makefile Unifies the project packaging into one set of modules. 7 years ago
README.rst Added "network" to the list of required nova services. 7 years ago Unifies the project packaging into one set of modules. 7 years ago Added --only-selenium option in 6 years ago make execute with python by default 7 years ago
tox.ini Add tox.ini file. 6 years ago


Horizon (OpenStack Dashboard)

Horizon is a Django-based project aimed at providing a complete OpenStack Dashboard along with an extensible framework for building new dashboards from reusable components. The openstack_dashboard module is a reference implementation of a Django site that uses the horizon app to provide web-based interactions with the various OpenStack projects.

For release management:

For blueprints and feature specifications:

For issue tracking:

Getting Started

For local development, first create a virtualenv for the project. In the tools directory there is a script to create one for you:

$ python tools/

Alternatively, the script will also install the environment for you and then run the full test suite to verify everything is installed and functioning correctly.

Now that the virtualenv is created, you need to configure your local environment. To do this, create a file in the openstack_dashboard/local/ directory. There is a file there that may be used as a template.

If all is well you should able to run the development server locally:

$ tools/ runserver

or, as a shortcut:

$ ./ --runserver

Settings Up OpenStack

The recommended tool for installing and configuring the core OpenStack components is Devstack. Refer to their documentation for getting Nova, Keystone, Glance, etc. up and running.


The minimum required set of OpenStack services running includes the following:

  • Nova (compute, api, scheduler, network, and volume services)
  • Glance
  • Keystone

Optional support is provided for Swift.


For development, start with the getting started instructions above. Once you have a working virtualenv and all the necessary packages, read on.

If dependencies are added to either horizon or openstack-dashboard, they should be added to tools/pip-requires.

The script invokes tests and analyses on both of these components in its process, and it is what Jenkins uses to verify the stability of the project. If run before an environment is set up, it will ask if you wish to install one.

To run the unit tests:

$ ./

Building Contributor Documentation

This documentation is written by contributors, for contributors.

The source is maintained in the docs/source folder using reStructuredText and built by Sphinx

  • Building Automatically:

    $ ./ --docs
  • Building Manually:

    $ export DJANGO_SETTINGS_MODULE=local.local_settings
    $ python doc/
    $ sphinx-build -b html doc/source build/sphinx/html

Results are in the build/sphinx/html directory