OpenStack Dashboard (Horizon)
Go to file
Radomir Dopieralski fdf920e714 Configurable cell_class in DataTable
There are two changes in this proposal. One is to move the logic
for extracting cell data from the row datum (and handling auto columns)
to the Cell class, into a separate method for easy extending. The
second is to make that extending possible by making the cell class
configurable in the DataTable's meta.

Those changes are supposed to make it easier to extend the DataTable
with new kinds of cells -- for example, cells that contain an editable
widget, a progress bar, an icon, etc. as well as make it easier to
modify the behavior of the auto columns -- for example, by making it
possible to have some of the multi_select checkboxes preselected. Those
changes would also make it easier to integrate DataTable with a Django
FormSet.

Right now, in order to modify any of the proposed Cell.get_data
behavior, one has to make their own Row class and practically copy-paste
the whole Row.load_cells method, as there is no easy way to extend it.

Change-Id: I29277a9e77e1c413193fe80d3f8cfe001bf5d709
Closes-Bug: #1229677
2013-12-10 13:39:03 +01:00
.tx Sync Transifex config with the source lang change in Transifex 2013-08-30 15:30:04 +09:00
doc Plugin-based dashboard configuration 2013-12-04 10:47:22 +01:00
horizon Configurable cell_class in DataTable 2013-12-10 13:39:03 +01:00
openstack_dashboard Merge "Plugin-based dashboard configuration" 2013-12-10 12:24:40 +00:00
tools Import install_venv from oslo 2013-11-13 03:34:42 +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 Make HACKING.rst formatting sync with other repos 2013-11-11 10:46:57 -08: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 Import install_venv from oslo 2013-11-13 03:34:42 +09:00
README.rst Updating readme with grammar correction 2013-10-24 16:23:01 -05:00
requirements.txt Update troveclient to 1.0.0 2013-11-25 08:25:32 -08:00
run_tests.sh Update troveclient to 1.0.0 2013-11-25 08:25:32 -08:00
setup.cfg Open Icehouse development 2013-10-02 12:08:56 -07:00
setup.py Updated from global requirements 2013-10-01 16:13:10 +00:00
test-requirements.txt Updated from global requirements 2013-11-15 16:49:01 +00:00
tox.ini Gate on H4xx docstrings for pep8 2013-11-23 12:51:07 -05:00

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