openstack/horizon
Code Issues Proposed changes
OpenStack Dashboard (Horizon)
5,379 Commits 10 Branches 54 Tags 315 MiB
Python 63.1%
JavaScript 28.8%
HTML 6.5%
SCSS 1.5%
ae7f053cb0
Go to file
Akihiro Motoki ae7f053cb0 Translation import for 2014.2.1 Juno stable update 
* Runssian translation is newly added. They have made
  a great progress after Juno initial release.
* Translation udpate to catch up with Horizon code update

Change-Id: I60322009bf3000201c3bc2afe8abfa641a9be847
2014-12-04 02:38:36 +09:00
.tx Import translations from Transifex for Juno 2014-10-09 22:23:55 +09:00
doc Document token hash algorithm option 2014-10-10 10:59:59 +02:00
horizon Translation import for 2014.2.1 Juno stable update 2014-12-04 02:38:36 +09:00
openstack_dashboard Translation import for 2014.2.1 Juno stable update 2014-12-04 02:38:36 +09:00
tools Remove requirements style check 2014-07-08 09:50:14 -07:00
.gitignore Import translations from Transifex for Juno 2014-10-09 22:23:55 +09:00
.gitreview Opening stable/juno 2014-10-16 16:56:51 +02: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
CONTRIBUTING.rst Add CONTRIBUTING.rst 2014-07-09 14:47:57 +08:00
HACKING.rst Merge "Bringing HACKING.rst in correspondence with tox.ini" 2014-09-19 00:35:25 +00: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 Synced jsonutils from oslo-incubator 2014-05-27 12:25:45 +02: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-11-28 15:10:28 +00:00
run_tests.sh Unbundle bootstrap and use xstatic version 2014-09-30 18:46:47 +02:00
setup.cfg Opening stable/juno 2014-10-16 16:56:51 +02:00
setup.py Updated from global requirements 2014-05-01 13:44:26 +00:00
test-requirements.txt Updated from global requirements 2014-11-28 15:10:28 +00:00
tox.ini Remove #noqa from two common imports and add them to import_exceptions 2014-09-16 14:08:28 +04: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