spanner/README.rst

Spanner

Operation dashboard for OpenStack based on Ceilometer, Gnocchi, Aodh or some other OpenStack operation API.

• Free software: Apache license
• Source: http://git.openstack.org/cgit/openstack/spanner
• Bugs: http://bugs.launchpad.net/spanner-dashboard

Installation instructions

Begin by cloning the Horizon and spanner repositories:

git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/spanner

Create a virtual environment and install Horizon dependencies:

cd horizon
python tools/install_venv.py

Set up your local_settings.py file:

cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py

Open up the copied local_settings.py file in your preferred text editor. You will want to customize several settings:

• OPENSTACK_HOST should be configured with the hostname of your OpenStack server. Verify that the OPENSTACK_KEYSTONE_URL and OPENSTACK_KEYSTONE_DEFAULT_ROLE settings are correct for your environment. (They should be correct unless you modified your OpenStack server to change them.)

And enable it in Horizon:

cp ../spanner/_99_spanner.py.example openstack_dashboard/local/enabled/_99_spanner.py

Starting the app

If everything has gone according to plan, you should be able to run:

./run_tests.sh --runserver 0.0.0.0:8080

and have the application start on port 8080. The horizon dashboard will be located at http://localhost:8080/

Unit testing

The unit tests can be executed directly from within this spanner plugin project directory by using:

cd spanner
./run_tests.sh

This is made possible by the dependency in test-requirements.txt upon the horizon source, which pulls down all of the horizon and openstack_dashboard modules that the plugin uses.