stackforge
/
cloud-pydashie
Code Issues Proposed changes

adding more info to the readme

This commit is contained in:
adriant 2014-12-16 14:09:56 +13:00
parent 30db6ef5d5
commit 4837cbca93
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@ -3,7 +3,7 @@ Openstack-PyDashie
PyDashie is a port of `Dashing <https://github.com/Shopify/dashing>`_ by `Shopify <http://www.shopify.com/>`_ to Python 2.7
This is simply an implementation of pydashie tailored to showing information about an openstack cluster with nagios/icinga for monitoring. It is primarily for internal use.
This is simply an implementation of pydashie tailored to showing information about an openstack cluster with nagios/icinga for monitoring. It is primarily for internal use by maintainers of openstack deloyments, as the current flask file servicing may be somewhat unsafe for public access.
It uses the standard python clients for collecting formation from openstack across multiple regions.
@ -11,7 +11,7 @@ The nagios/icinga data is currently collected via ssh but in future might be mov
.. image:: http://evolvedlight.github.com/pydashie/images/mainscreen.png
NOTE: The current layout is hardcoded for 1080p. This might be changed to be configurable by the conf.yaml later. If you need to change the sizing, you can do so by changing the widget dimensions and number of columns within this function:
**NOTE**: The current layout is hardcoded for 1080p. This might be changed to be configurable by the conf.yaml later. If you need to change the sizing, you can do so by changing the widget dimensions and number of columns within this function:
https://github.com/catalyst/openstack-pydashie/blob/master/pydashie/assets/javascripts/app.js#L336
@ -50,6 +50,8 @@ Configuration is handled via a yaml file as follows:
Because of differences between allocation per region, and the need for a region list, each region is given it's own allocation data. We use this to know which regions to build clients for and aggregate data over, but in future might try and query a for a full region list and for allocation data from openstack itself.
The nagios collection relies on a local ssh key for the given username, and access for that key on the given host.
Widgets
############
@ -69,12 +71,16 @@ OR
Running
############
You can run the application by:
Provided you have a conf with working credentials and correctly named regions, you can run the application by:
pydashie -c conf.yaml
Goto localhost:5050 to view the application in action.
**NOTE**: Getting the app up and running quickly with just openstack credentials is relatively easy, and you can simply comment out the nagios samplers from:
https://github.com/catalyst/openstack-pydashie/blob/master/pydashie/openstack_app.py
The port and interface can also be set via the commandline:
pydashie -c conf.yaml -ip 0.0.0.0 -p 5050