openstack/horizon
Code Issues Proposed changes
OpenStack Dashboard (Horizon)
4,142 Commits 10 Branches 55 Tags 315 MiB
Python 63.1%
JavaScript 28.8%
HTML 6.5%
SCSS 1.5%
628e908a3d
Go to file
Gary W. Smith 628e908a3d Fix build instructions and formatting in README 
- Fix manual build command
- Fix formatting of command-line examples, directory names
- Rename 'folder' to 'directory' for consistency
- Update sphinx URL

Partial-bug: #1257725
Change-Id: I078bc5b9c931d4bf4e57c8fe7b335db99cc92c29
2014-05-09 18:22:50 +00:00
.tx Update .tx/config with type of files 2014-03-21 15:30:03 +01:00
doc Merge "Refer local_settings in doc to customize settings" 2014-05-06 03:00:09 +00:00
horizon Fix unicode error when assertMessageCount() fails 2014-05-01 16:00:52 +01:00
openstack_dashboard Merge "To allow keypair name could contain spaces" 2014-05-07 15:32:15 +00:00
tools Sync latest Oslo 2014-04-05 23:36:07 +09:00
.gitignore Updates .gitignore 2013-11-28 08:53:42 +00:00
.gitreview Add .gitreview and rfc.sh. 2011-10-28 09:50:35 -04:00
.mailmap Update my mailmap 2013-10-25 14:49:23 +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 Remove #noqa from most common imports and add them to import_exceptions 2014-01-07 12:26:35 +01:00
LICENSE Initial commit 2011-01-12 13:43:31 -08:00
Makefile Unifies the project packaging into one set of modules. 2012-02-29 00:20:13 -08:00
manage.py Gate on H102 Apache 2.0 license header not found for pep8 2013-11-19 13:55:04 -05:00
MANIFEST.in Drop NodeJS dependency in favor of pure-python lesscpy 2013-08-16 09:31:08 +02:00
openstack-common.conf Remove unused openstack.common modules 2014-04-02 12:42:01 +00:00
README.rst Fix build instructions and formatting in README 2014-05-09 18:22:50 +00:00
requirements.txt Updated from global requirements 2014-04-22 01:47:55 +00:00
run_tests.sh Merge "Add tox env to build docs" 2014-04-18 21:27:50 +00:00
setup.cfg Open Juno development 2014-03-31 10:32:44 +02:00
setup.py Updated from global requirements 2013-10-01 16:13:10 +00:00
test-requirements.txt Switch over to oslosphinx 2014-03-21 15:23:44 +01:00
tox.ini Merge "Use the latest Django 1.4 release to test Horizon" 2014-04-18 23:29:56 +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

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 directory using reStructuredText and built by Sphinx

  • Building Automatically:

    $ ./run_tests.sh --docs

  • Building Manually:

    $ tools/with_venv.sh sphinx-build doc/source doc/build/html

Results are in the doc/build/html directory