OpenStack Dashboard (Horizon)
Go to file
OpenStack Proposal Bot c3014a85dd Updated from global requirements
Change-Id: I68ca9943bd611061cf34f79d786b161226f13171
2014-09-19 14:50:07 +02:00
.tx Update Transifex resource name for havana 2014-01-29 18:14:59 +09:00
doc Release notes for the Havana release 2013-10-02 12:00:52 -07:00
horizon Fix multiple Cross-Site Scripting (XSS) vulnerabilities 2014-07-08 16:04:01 +01:00
openstack_dashboard Merge "Check host is not none in each availability zone" into stable/havana 2014-08-23 16:43:13 +00:00
tools Import install_venv from oslo 2013-11-18 01:23:18 +09:00
.gitignore Added openstack_dashboard/local/.secret_key_store to .gitignore. 2013-02-11 17:12:56 +00:00
.gitreview Open stable/havana 2013-10-17 17:29:25 +02:00
.mailmap remove 'import *' usage (or mark is #noqa) 2013-07-30 11:45:39 +08:00
.pylintrc updating run_tests.sh to mimic other openstack projects, pep8, pylint, coverage 2011-08-31 14:41:36 -07:00
HACKING.rst Add HACKING.rst 2013-06-11 10:52:50 -07:00
LICENSE Initial commit 2011-01-12 13:43:31 -08:00
MANIFEST.in Drop NodeJS dependency in favor of pure-python lesscpy 2013-08-16 09:31:08 +02:00
Makefile Unifies the project packaging into one set of modules. 2012-02-29 00:20:13 -08:00
README.rst Drop NodeJS dependency in favor of pure-python lesscpy 2013-08-16 09:31:08 +02:00
manage.py Delete and launch devices on the topology view 2013-08-29 00:07:27 -07:00
openstack-common.conf Import install_venv from oslo 2013-11-18 01:23:18 +09:00
requirements.txt Updated from global requirements 2014-09-19 14:50:07 +02:00
run_tests.sh Add extra extension file to makemessage command line 2013-12-04 16:55:21 +09:00
setup.cfg Bump stable/havana next version to 2013.2.4 2014-04-21 15:34:20 -07:00
setup.py Updated from global requirements 2013-10-01 16:13:10 +00:00
test-requirements.txt Updated from global requirements 2014-09-19 14:50:07 +02:00
tox.ini Set python hash seed to 0 in tox.ini 2014-08-22 12:01:17 +00:00

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

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.

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