openstack
/
horizon
Code Issues Proposed changes
OpenStack Dashboard (Horizon)
3,079 Commits 9 Branches 51 Tags 313 MiB
Python 63%
JavaScript 28.9%
HTML 6.5%
SCSS 1.5%
Go to file
Akihiro MOTOKI 28749792fb Import install_venv from oslo 
The new version of install_venv_common evaluates requirements.txt
and test-requirements.txt at the same time and we avoid Django 1.6
is installed when evaluating django-nose dependencies.

Change-Id: I2ab7108b3615ac6c0525089b81b80e5c0a4793fc
Closes-Bug: #1250581
(cherry picked from commit 7a0581bb70)
 		2013-11-18 01:23:18 +09:00
.tx Sync Transifex config with the source lang change in Transifex 2013-08-30 15:30:04 +09:00
doc Release notes for the Havana release 2013-10-02 12:00:52 -07:00
horizon Avoid discarding precision of metering data 2013-10-21 07:47:57 +01:00
openstack_dashboard Avoid discarding precision of metering data 2013-10-21 07:47:57 +01: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 capping python-troveclient version 2013-10-11 22:18:23 +11:00
run_tests.sh Make some PEP8 understandable in run_tests.sh -p 2013-09-25 12:12:27 +09:00
setup.cfg Open stable/havana 2013-10-17 17:29:25 +02:00
setup.py Updated from global requirements 2013-10-01 16:13:10 +00:00
test-requirements.txt Updated from global requirements 2013-10-01 16:13:10 +00:00
tox.ini PEP8 E126 has been resolved 2013-09-17 20:48:09 +09: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