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.
Jenkins 9ad9af4b8d Merge "Allow forms to disable autofill in all browsers" into stable/icehouse 4 years ago
.tx Import translations from Transifex for Icehouse 5 years ago
doc Plugin-based panel group configuration 5 years ago
horizon Merge "Allow forms to disable autofill in all browsers" into stable/icehouse 4 years ago
openstack_dashboard Merge "Allow forms to disable autofill in all browsers" into stable/icehouse 4 years ago
tools Sort requirement files in alphabetical order 5 years ago
.gitignore Updates .gitignore 5 years ago
.gitreview Opening stable/icehouse 5 years ago
.mailmap Update my mailmap 5 years ago
.pylintrc updating run_tests.sh to mimic other openstack projects, pep8, pylint, coverage 7 years ago
HACKING.rst Remove #noqa from most common imports and add them to import_exceptions 5 years ago
LICENSE Initial commit 8 years ago
MANIFEST.in Drop NodeJS dependency in favor of pure-python lesscpy 5 years ago
Makefile Unifies the project packaging into one set of modules. 7 years ago
README.rst Improve contributor documentation 5 years ago
manage.py Gate on H102 Apache 2.0 license header not found for pep8 5 years ago
openstack-common.conf Import install_venv from oslo 5 years ago
requirements.txt add httplib2 explicitly to requirements.txt 4 years ago
run_tests.sh Merge "Remove English compiled catalogs after compilemessages" 5 years ago
setup.cfg Bump stable/icehouse next version to 2014.1.3 4 years ago
setup.py Updated from global requirements 5 years ago
test-requirements.txt Updated from global requirements 4 years ago
tox.ini Set python hash seed to 0 in tox.ini 4 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 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