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.
 
 
 
 
 
 
Gabriel Hurley 052aa55d34 Unifies the project packaging into one set of modules. 8 years ago
docs Unifies the project packaging into one set of modules. 8 years ago
horizon Unifies the project packaging into one set of modules. 8 years ago
openstack_dashboard Unifies the project packaging into one set of modules. 8 years ago
tools Unifies the project packaging into one set of modules. 8 years ago
.bzrignore Re-architects the OpenStack Dashboard for modularity and extensibility. 8 years ago
.gitignore Unifies the project packaging into one set of modules. 8 years ago
.gitreview Add .gitreview and rfc.sh. 8 years ago
.pylintrc updating run_tests.sh to mimic other openstack projects, pep8, pylint, coverage 8 years ago
AUTHORS Adds test (copied from Glance/Keystone) to verify authors file is up-to-date. 8 years ago
LICENSE Initial commit 9 years ago
Makefile Unifies the project packaging into one set of modules. 8 years ago
README.rst Unifies the project packaging into one set of modules. 8 years ago
manage.py Unifies the project packaging into one set of modules. 8 years ago
run_tests.sh Unifies the project packaging into one set of modules. 8 years ago
setup.py Unifies the project packaging into one set of modules. 8 years ago

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

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.

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 tools/pip-requires.

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 docs/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