openstack/horizon
Code Issues Proposed changes
OpenStack Dashboard (Horizon)
2,966 Commits 10 Branches 51 Tags 315 MiB
Python 63.1%
JavaScript 28.8%
HTML 6.5%
SCSS 1.5%
6f1307e472
Go to file
Akihiro MOTOKI 6f1307e472 Determine security group API dynamically 
This commit removes enable_security_group from local_settings.py
and determines which security group API should be used (nova or
neutron).

Closes-Bug: #1227804

As described in bug 1203413, there is a case where Nova security group
with Neutron driver causes a problem. The type of 'name' attribute in
add_security_group_to_instance and remove_security_group_from_instance
depends on the backend, integer for nova security group driver and
UUID for quantum security group driver to make it work as expected.

enable_security_group config parameter produces a situation where
Nova security group with Neutron driver. We can avoid this situation
by removing this parameter when using Horizon.

Change-Id: I713c6ad166e142929f0a708e93a8fedb0de48640
2013-09-23 13:49:02 +09:00
.tx Sync Transifex config with the source lang change in Transifex 2013-08-30 15:30:04 +09:00
doc Merge "Adding documentation to Tables and Workflows" 2013-09-17 12:04:06 +00:00
horizon Merge "PEP8 E126 has been resolved" 2013-09-19 07:50:52 +00:00
openstack_dashboard Determine security group API dynamically 2013-09-23 13:49:02 +09:00
tools Enclose command args in with_venv.sh 2013-09-09 14:21:41 +08:00
.gitignore Added openstack_dashboard/local/.secret_key_store to .gitignore. 2013-02-11 17:12:56 +00:00
.gitreview Add .gitreview and rfc.sh. 2011-10-28 09:50:35 -04: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
Makefile Unifies the project packaging into one set of modules. 2012-02-29 00:20:13 -08:00
manage.py Delete and launch devices on the topology view 2013-08-29 00:07:27 -07:00
MANIFEST.in Drop NodeJS dependency in favor of pure-python lesscpy 2013-08-16 09:31:08 +02:00
openstack-common.conf Adding RBAC policy system and checks for identity 2013-08-26 10:32:28 -06:00
README.rst Drop NodeJS dependency in favor of pure-python lesscpy 2013-08-16 09:31:08 +02:00
requirements.txt update neutronclient to 2.3.0 minimum 2013-09-03 16:38:13 -04:00
run_tests.sh ./run_tests.sh --makemessages update English PO files only 2013-09-12 18:54:55 +09:00
setup.cfg Updated from global requirements 2013-08-08 13:16:35 -03:00
setup.py Updated from global requirements 2013-08-08 13:16:35 -03:00
test-requirements.txt Updated from global requirements 2013-08-08 13:16:35 -03: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