Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

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.

Merge "Sync latest Oslo"

latest commit dc8bd1eedc
Jenkins authored April 20, 2014 openstack-gerrit committed April 20, 2014
Octocat-spinner-32 .tx Update .tx/config with type of files March 21, 2014
Octocat-spinner-32 doc Merge "Use built-in print() instead of print statement" April 08, 2014
Octocat-spinner-32 horizon Merge "Support for django csrf token" April 19, 2014
Octocat-spinner-32 openstack_dashboard Merge "Sync latest Oslo" April 20, 2014
Octocat-spinner-32 tools Sync latest Oslo April 05, 2014
Octocat-spinner-32 .gitignore Updates .gitignore November 28, 2013
Octocat-spinner-32 .gitreview Add .gitreview and rfc.sh. October 28, 2011
Octocat-spinner-32 .mailmap Update my mailmap October 25, 2013
Octocat-spinner-32 .pylintrc updating run_tests.sh to mimic other openstack projects, pep8, pylint… August 31, 2011
Octocat-spinner-32 HACKING.rst Remove #noqa from most common imports and add them to import_exceptions January 07, 2014
Octocat-spinner-32 LICENSE Initial commit January 12, 2011
Octocat-spinner-32 MANIFEST.in Drop NodeJS dependency in favor of pure-python lesscpy August 16, 2013
Octocat-spinner-32 Makefile Unifies the project packaging into one set of modules. February 29, 2012
Octocat-spinner-32 README.rst Improve contributor documentation December 03, 2013
Octocat-spinner-32 manage.py Gate on H102 Apache 2.0 license header not found for pep8 November 19, 2013
Octocat-spinner-32 openstack-common.conf Remove unused openstack.common modules April 02, 2014
Octocat-spinner-32 requirements.txt Merge "Adding python-saharaclient to requirements" April 11, 2014
Octocat-spinner-32 run_tests.sh Merge "Add tox env to build docs" April 18, 2014
Octocat-spinner-32 setup.cfg Open Juno development March 31, 2014
Octocat-spinner-32 setup.py Updated from global requirements October 01, 2013
Octocat-spinner-32 test-requirements.txt Switch over to oslosphinx March 21, 2014
Octocat-spinner-32 tox.ini Merge "Use the latest Django 1.4 release to test Horizon" April 18, 2014
README.rst

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/install_venv.py

Alternatively, the run_tests.sh 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 local_settings.py file in the openstack_dashboard/local/ directory. There is a local_settings.py.example file there that may be used as a template.

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

$ tools/with_venv.sh manage.py runserver

or, as a shortcut:

$ ./run_tests.sh --runserver

Setting 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.

Note

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.

Development

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 requirements.txt.

The run_tests.sh 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:

$ ./run_tests.sh

Building Contributor Documentation

This documentation is written by contributors, for contributors.

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

  • Building Automatically:

    $ ./run_tests.sh --docs
    
  • Building Manually:

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

Results are in the build/sphinx/html directory

Something went wrong with that request. Please try again.