Merge "Added collateral to README.rst document"

This commit is contained in:
Jenkins 2016-10-28 12:32:39 +00:00 committed by Gerrit Code Review
commit 2837d6bd33

View File

@ -4,21 +4,43 @@ collectd-ceilometer-plugin
OpenStack Ceilometer plugin for collectd. OpenStack Ceilometer plugin for collectd.
This plugin for collectd publishes telemetry data gathered by collectd to Ceilometer. This plugin for collectd publishes telemetry data gathered by collectd to
This enables a more comprehensive telemetry set to be made available to Ceilometer Ceilometer. This enables a more comprehensive telemetry set to be made
which will enable smarter scheduling and environmental service assurance monitoring. available to Ceilometer which will enable smarter scheduling and environmental
service assurance monitoring.
* Free software: Apache license * Free software: Apache license
* Documentation: http://docs.openstack.org/developer/collectd-ceilometer-plugin
* Source: http://git.openstack.org/cgit/openstack/collectd-ceilometer-plugin * Source: http://git.openstack.org/cgit/openstack/collectd-ceilometer-plugin
* Installation:
http://git.openstack.org/cgit/openstack/collectd-ceilometer-plugin/tree/doc/source/installation.rst
* Bugs: http://bugs.launchpad.net/collectd-ceilometer-plugin * Bugs: http://bugs.launchpad.net/collectd-ceilometer-plugin
* Usage:
http://git.openstack.org/cgit/openstack/collectd-ceilometer-plugin/tree/doc/source/usage.rst
* Contact: E-mail the dev mailing list with the [collectd-ceilometer-plugin] tag * Contact: E-mail the dev mailing list with the [collectd-ceilometer-plugin] tag
mailto:openstack-dev@lists.openstack.org?subject=[collectd-ceilometer-plugin] mailto:openstack-dev@lists.openstack.org?subject=[collectd-ceilometer-plugin]
Collateral
----------
The following are links to background information, collateral and references
to provide a clearer view on the need for this plugin, what it does and how it
works:
* An overview of Ceilometer and its architecture:
http://docs.openstack.org/developer/ceilometer/overview.html
http://docs.openstack.org/developer/ceilometer/architecture.html
* Official collectd website:
https://collectd.org/
* Information on how collectd is enabled for Openstack:
https://01.org/openstack/blogs/emmalfoley/2016/collectd-enabling-openstack
* Presentation on how collectd, Ceilometer and DPDK work together:
https://www.youtube.com/watch?v=BdebhsBFEJs
Features Features
-------- --------
* Converts from collectd data sources to Ceilometer format * Converts from collectd data sources to Ceilometer format
* * Adds units for Ceilometer * Adds units for Ceilometer
* Devstack plugin * Devstack plugin
* * Configure and deploy plugin * Configure and deploy plugin