summaryrefslogtreecommitdiff
path: root/openstack-dashboard/README
diff options
context:
space:
mode:
Diffstat (limited to 'openstack-dashboard/README')
-rw-r--r--openstack-dashboard/README49
1 files changed, 15 insertions, 34 deletions
diff --git a/openstack-dashboard/README b/openstack-dashboard/README
index 3c9053a2..f902e97d 100644
--- a/openstack-dashboard/README
+++ b/openstack-dashboard/README
@@ -1,53 +1,34 @@
+===================
OpenStack Dashboard
--------------------
+===================
The OpenStack Dashboard is a reference implementation of a Django site that
-uses the Django-Nova project to provide web based interactions with the
-OpenStack Nova cloud controller.
+uses the Horizon project to provide web based interactions with the various
+OpenStack projects.
Getting Started
----------------
+===============
-For local development, first create a virtualenv for local development.
+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.
-
-Finally, issue the django syncdb command:
-
- $ tools/with_venv.sh dashboard/manage.py syncdb
-
-If after you have specified the admin user the script appears to hang, it
-probably means the installation of Nova being referred to in local_settings.py
-is unavailable.
-
+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
-Adding openstackx Extensions to Nova
-------------------------------------
-
-If you are seeing large numbers of 404 exceptions on operations such as listing
-servers, you are probably not running the openstackx extensions that the
-dashboard depends on. You will need to download the openstackx code from
-
-> https://github.com/cloudbuilders/openstackx
-
-and add the following option to your nova instantiation:
-
-> --osapi_extensions_path=/path/to/openstackx/extensions
+Settings Up OpenStack
+=====================
-The rackspace cloudbuilders nova.sh script automates this process and creates a
-full nova installation compatible with the dashboard. You can acquire this
-script from the repository at
+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.
-https://github.com/cloudbuilders/deploy.sh
+.. _Devstack: http://devstack.org/