From 41333abfa8267433e01f681a1dbce6f606e7d313 Mon Sep 17 00:00:00 2001 From: Helena McGough Date: Wed, 12 Oct 2016 15:32:21 +0000 Subject: [PATCH] Added collateral to README.rst document Change-Id: I888cbb66b789598426d306c8bc70112df2211162 --- README.rst | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index cc32c09..ac025f9 100644 --- a/README.rst +++ b/README.rst @@ -4,21 +4,43 @@ collectd-ceilometer-plugin OpenStack Ceilometer plugin for collectd. -This plugin for collectd publishes telemetry data gathered by collectd to Ceilometer. -This enables a more comprehensive telemetry set to be made available to Ceilometer -which will enable smarter scheduling and environmental service assurance monitoring. +This plugin for collectd publishes telemetry data gathered by collectd to +Ceilometer. This enables a more comprehensive telemetry set to be made +available to Ceilometer which will enable smarter scheduling and environmental +service assurance monitoring. * Free software: Apache license -* Documentation: http://docs.openstack.org/developer/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 +* 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 - 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 -------- * Converts from collectd data sources to Ceilometer format -* * Adds units for Ceilometer + * Adds units for Ceilometer * Devstack plugin -* * Configure and deploy plugin + * Configure and deploy plugin +