Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 111 lines (69 sloc) 3.197 kb
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
1 =============================
2 Horizon (OpenStack Dashboard)
3 =============================
b9dd01a6 »
2011-03-03 Combined django-nova and openstack-dashboard
4
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
5 Horizon is a Django-based project aimed at providing a complete OpenStack
6 Dashboard along with an extensible framework for building new dashboards
7 from reusable components. The ``openstack_dashboard`` module is a reference
8 implementation of a Django site that uses the ``horizon`` app to provide
9 web-based interactions with the various OpenStack projects.
bebaafaf »
2011-06-17 Updated README
10
11 For release management:
12
fdcbe0fa »
2011-10-20 Update README
13 * https://launchpad.net/horizon
bebaafaf »
2011-06-17 Updated README
14
15 For blueprints and feature specifications:
16
fdcbe0fa »
2011-10-20 Update README
17 * https://blueprints.launchpad.net/horizon
bebaafaf »
2011-06-17 Updated README
18
19 For issue tracking:
20
fdcbe0fa »
2011-10-20 Update README
21 * https://bugs.launchpad.net/horizon
671e4f42 »
2011-08-31 updating README to explain project/repo structure
22
0074328f »
2012-05-11 Updating Horizon to use LESS.
23
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
24 Getting Started
25 ===============
26
27 For local development, first create a virtualenv for the project.
28 In the ``tools`` directory there is a script to create one for you:
29
30 $ python tools/install_venv.py
31
32 Alternatively, the ``run_tests.sh`` script will also install the environment
33 for you and then run the full test suite to verify everything is installed
34 and functioning correctly.
35
36 Now that the virtualenv is created, you need to configure your local
9bea7957 »
2012-03-02 Made readme a little more clear on where to put local_settings.py
37 environment. To do this, create a ``local_settings.py`` file in the
38 ``openstack_dashboard/local/`` directory. There is a
39 ``local_settings.py.example`` file there that may be used as a template.
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
40
41 If all is well you should able to run the development server locally:
42
43 $ tools/with_venv.sh manage.py runserver
44
45 or, as a shortcut::
46
47 $ ./run_tests.sh --runserver
48
49
3b2cdf4a »
2013-10-24 Updating readme with grammar correction
50 Setting Up OpenStack
51 ====================
c1b5d04c »
2011-11-16 meaningless change to drive CI
52
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
53 The recommended tool for installing and configuring the core OpenStack
54 components is `Devstack`_. Refer to their documentation for getting
55 Nova, Keystone, Glance, etc. up and running.
671e4f42 »
2011-08-31 updating README to explain project/repo structure
56
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
57 .. _Devstack: http://devstack.org/
671e4f42 »
2011-08-31 updating README to explain project/repo structure
58
69997802 »
2012-03-13 Updated docs to reflect current required services for Horizon.
59 .. note::
60
61 The minimum required set of OpenStack services running includes the
62 following:
63
873d9df3 »
2012-03-29 Added "network" to the list of required nova services.
64 * Nova (compute, api, scheduler, network, *and* volume services)
69997802 »
2012-03-13 Updated docs to reflect current required services for Horizon.
65 * Glance
66 * Keystone
67
68 Optional support is provided for Swift.
69
671e4f42 »
2011-08-31 updating README to explain project/repo structure
70
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
71 Development
72 ===========
a1757011 »
2012-01-04 Unified horizon and openstack-dashboard environments.
73
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
74 For development, start with the getting started instructions above.
75 Once you have a working virtualenv and all the necessary packages, read on.
a1757011 »
2012-01-04 Unified horizon and openstack-dashboard environments.
76
d3c91de7 »
2013-12-03 Improve contributor documentation
77 If dependencies are added to either ``horizon`` or ``openstack_dashboard``,
5b24518b »
2013-05-28 Renames tools/pip-requires to requirements.txt
78 they should be added to ``requirements.txt``.
671e4f42 »
2011-08-31 updating README to explain project/repo structure
79
97428427 »
2011-10-31 Re-architects the OpenStack Dashboard for modularity and extensibility.
80 The ``run_tests.sh`` script invokes tests and analyses on both of these
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
81 components in its process, and it is what Jenkins uses to verify the
a1757011 »
2012-01-04 Unified horizon and openstack-dashboard environments.
82 stability of the project. If run before an environment is set up, it will
83 ask if you wish to install one.
7fbd0435 »
2011-10-27 adding developer docs
84
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
85 To run the unit tests::
7fbd0435 »
2011-10-27 adding developer docs
86
87 $ ./run_tests.sh
88
89 Building Contributor Documentation
052aa55d »
2012-02-28 Unifies the project packaging into one set of modules.
90 ==================================
7fbd0435 »
2011-10-27 adding developer docs
91
92 This documentation is written by contributors, for contributors.
93
f1a8e0c5 »
2012-06-08 Move docs to doc.
94 The source is maintained in the ``doc/source`` folder using
7fbd0435 »
2011-10-27 adding developer docs
95 `reStructuredText`_ and built by `Sphinx`_
96
97 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
98 .. _Sphinx: http://sphinx.pocoo.org/
99
100 * Building Automatically::
101
6e7d2084 »
2011-10-27 adding version to project, setting up autobuild of docs with ./run_te…
102 $ ./run_tests.sh --docs
7fbd0435 »
2011-10-27 adding developer docs
103
104 * Building Manually::
105
106 $ export DJANGO_SETTINGS_MODULE=local.local_settings
107 $ python doc/generate_autodoc_index.py
108 $ sphinx-build -b html doc/source build/sphinx/html
109
6e7d2084 »
2011-10-27 adding version to project, setting up autobuild of docs with ./run_te…
110 Results are in the `build/sphinx/html` directory
Something went wrong with that request. Please try again.