tuskar-ui/openstack-dashboard
Gabriel Hurley 9742842795 Re-architects the OpenStack Dashboard for modularity and extensibility.
Implements blueprint extensible-architecture.
Implements blueprint improve-dev-documentation.
Implements blueprint gettext-everywhere.
Implements blueprint sphinx-docs.

Complete re-architecture of the dashboard to transform it from a standalone django-openstack app to a Horizon framework for building dashboards. See the docs for more information.

Incidentally fixes the following bugs:

Fixes bug 845868 -- no PEP8 violations.
Fixes bug 766096 -- the dashboard can now be installed at any arbitrary URL.
Fixes bug 879111 -- tenant id is now controlled solely by the tenant switcher, not the url (which was disregarded anyway)
Fixes bug 794754 -- output of venv installation is considerably reduced.

Due to the scale and scope of this patch I recommend reviewing it on github: https://github.com/gabrielhurley/horizon/tree/extensible_architecture

Change-Id: I8e63f7ea235f904247df40c33cb66338d973df9e
2011-11-07 12:59:21 -08:00
..
dashboard Re-architects the OpenStack Dashboard for modularity and extensibility. 2011-11-07 12:59:21 -08:00
debian stub out build files 2011-06-22 17:24:36 -07:00
local Re-architects the OpenStack Dashboard for modularity and extensibility. 2011-11-07 12:59:21 -08:00
tools Re-architects the OpenStack Dashboard for modularity and extensibility. 2011-11-07 12:59:21 -08:00
Makefile stub out build files 2011-06-22 17:24:36 -07:00
README Re-architects the OpenStack Dashboard for modularity and extensibility. 2011-11-07 12:59:21 -08:00
setup.py Fix identifier for PyPi 2011-10-02 21:20:33 -07:00

===================
OpenStack Dashboard
===================

The OpenStack Dashboard is a reference implementation of a Django site that
uses the Horizon project to provide web based interactions with the various
OpenStack projects.


Getting Started
===============

For local development, first create a virtualenv for the project.
A tool is included to create one for you:

  $ python tools/install_venv.py

Now that the virtualenv is created, you need to configure your local
environment.  To do this, create a ``local_settings.py`` file in the ``local/``
directory.  There is a ``local_settings.py.example`` file there that may be
used as a template.

If all is well you should now able to run the server locally:

  $ tools/with_venv.sh dashboard/manage.py 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.

.. _Devstack: http://devstack.org/