RETIRED, The UI component for Tuskar
Go to file
Gabriel Hurley 1721ba9c4a Adds dash/panel app templates, mgmt commands, template loader.
Implements blueprint scaffolding.

Using custom management commands you can now create the majority
of the boilerplate code for a new dashboard or panel from a
set of basic templates with a single command. See the docs
for more info.

Additionally, in support of the new commands (and inherent
codified directory structure) there's a new template loader
included which can load templates from "templates" directories
in any registered panel.

Change-Id: I1df5eb152cb18694dc89d562799c8d3e8950ca6f
2012-05-01 14:41:20 -07:00
docs Adds dash/panel app templates, mgmt commands, template loader. 2012-05-01 14:41:20 -07:00
horizon Adds dash/panel app templates, mgmt commands, template loader. 2012-05-01 14:41:20 -07:00
openstack_dashboard Adds dash/panel app templates, mgmt commands, template loader. 2012-05-01 14:41:20 -07:00
tools Adds dash/panel app templates, mgmt commands, template loader. 2012-05-01 14:41:20 -07:00
.bzrignore Re-architects the OpenStack Dashboard for modularity and extensibility. 2011-11-07 12:59:21 -08:00
.gitignore Makes setup.py actually list it's dependencies for pip/easy_install. 2012-02-29 17:31:12 -08:00
.gitreview Add .gitreview and rfc.sh. 2011-10-28 09:50:35 -04:00
.mailmap Add distribute to test-requires. 2012-04-18 07:39:27 -07:00
.pylintrc updating run_tests.sh to mimic other openstack projects, pep8, pylint, coverage 2011-08-31 14:41:36 -07:00
AUTHORS Merge "Make it easy to have VNC without scrollbars" 2012-04-27 01:23:45 +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 Unifies the project packaging into one set of modules. 2012-02-29 00:20:13 -08:00
MANIFEST.in Add missing docs files in tarball 2012-03-14 16:12:52 +01:00
README.rst Added "network" to the list of required nova services. 2012-03-29 18:13:04 -07:00
run_tests.sh Adds dash/panel app templates, mgmt commands, template loader. 2012-05-01 14:41:20 -07:00
setup.py make setup.py execute with python by default 2012-03-22 11:11:37 +01: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

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 tools/pip-requires.

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 docs/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