1f38f87138
When building the documentation via run_tests.sh, doc/source/conf.py explicitly sets the DJANGO_SETTINGS_MODULE environment variable, overriding any existing value that it already has. Furthermore, it sets it to point to a settings file that does not use keystone v3, which is expected by the tests (and is the source of the warning). Note that when running unit tests via run_tests.sh, a different settings file is supplied which DOES use keystone v3. Change the doc/source/conf.py to only set DJANGO_SETTINGS_MODULE if it is not already set. Change tox.ini and run_tests.sh to set DJANGO_SETTINGS_MODULE to the same settings file used by the unit tests, with keystone v3 support. Change-Id: Ib297e4188f2426cf575300998bc9d50f36e48f4f Closes-Bug: #1257725 |
||
---|---|---|
.tx | ||
doc | ||
horizon | ||
openstack_dashboard | ||
tools | ||
.gitignore | ||
.gitreview | ||
.mailmap | ||
.pylintrc | ||
HACKING.rst | ||
LICENSE | ||
MANIFEST.in | ||
Makefile | ||
README.rst | ||
manage.py | ||
openstack-common.conf | ||
requirements.txt | ||
run_tests.sh | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
README.rst
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
directory
using reStructuredText and
built by Sphinx
Building Automatically:
$ ./run_tests.sh --docs
Building Manually:
$ tools/with_venv.sh sphinx-build doc/source doc/build/html
Results are in the doc/build/html
directory