Add documentation

- Update README.rst for features
- Update installation instructions

Change-Id: I9891d485ca46414367d9fca17e6ffc8f9c5ef4c6
This commit is contained in:
Emma Foley 2015-12-17 16:27:19 +00:00
parent ecc9a6ee9d
commit 92331ba067
2 changed files with 38 additions and 5 deletions

View File

@ -16,4 +16,7 @@ which will enable smarter scheduling and environmental service assurance monitor
Features
--------
* TODO
* Converts from collectd data sources to Ceilometer format
* * Adds units for Ceilometer
* Devstack plugin
* * Configure and deploy plugin

View File

@ -4,9 +4,39 @@ Installation
At the command line::
$ pip install collectd_ceilmeter
- Run stack.sh with local.conf configured for ceilometer.
Or, if you have virtualenvwrapper installed::
- Configure the Openstack plugin - for more information see the file example.conf
default configuration place is in /etc/collectd.d/collectd-ceilometer-plugin.conf
$ mkvirtualenv collectd_ceilometer
$ pip install collectd_ceilometer
- Enable some read plugins to get some stats in /etc/collectd.conf
- $ sudo service collectd start
Manual install::
- Run stack.sh with local.conf configured for ceilometer.
- git clone https://github.com/openstack/collectd-ceilometer-plugin.git
- Enable Python plugin in /etc/collectd.conf
<LoadPlugin python>
Globals true
</LoadPlugin>
- Enable the Openstack plugin in collectd configuration file:
(use example.conf)
<Plugin python>
ModulePath "/path/to/your/pyton/modules"
LogTraces true
Interactive false
Import "collectd_openstack_plugin"
</Plugin>
- Configure the Openstack plugin - for more information see the file example.conf
- Enable some read plugins to get some stats
- $ sudo service collectd start