From fab730e4f03f497cdf7197fdc411b7acb7298ce3 Mon Sep 17 00:00:00 2001
From: Guo Ruijing <ruijing.guo@intel.com>
Date: Mon, 25 Jul 2016 15:46:02 -0400
Subject: Update README

Change-Id: I1575b85c68e58c97444d9b6191a8f50dd63cc143
Signed-off-by: Guo Ruijing <ruijing.guo@intel.com>
---
 src/fuel-plugin/README.md | 64 +++++++++++++++++++++++++++++++++--------------
 1 file changed, 45 insertions(+), 19 deletions(-)

diff --git a/src/fuel-plugin/README.md b/src/fuel-plugin/README.md
index 49eda5cf..8ba97f6b 100644
--- a/src/fuel-plugin/README.md
+++ b/src/fuel-plugin/README.md
@@ -1,13 +1,8 @@
-Fuel Plugin for Collectd-Ceilometer
-===================================
+plugin-collectd-ceilometer
+=========================
 
-Collectd-Ceilometer plugin
---------------------------
-
-Overview
---------
-
-Fuel plugin collectd-ceilometer is developed to deploy collectd-ceilometer plugin
+Plugin description
+Installs collectd-ceilometer on base-os node via a fuel plugin.
 
 Requirements
 ------------
@@ -16,18 +11,49 @@ Requirements
 |----------------------------------|-----------------|
 | Mirantis OpenStack compatibility | 9.0             |
 
-Recommendations
----------------
 
-None.
+Documents
+---------
+
+1. https://wiki.openstack.org/wiki/Fuel
+2. https://wiki.openstack.org/wiki/Fuel/Plugins
+
+Build/Deploy/Verify
+-------------------
 
-Limitations
------------
+1) install fuel plugin builder (fpb)
+    sudo apt-get install -y ruby-dev rubygems-integration python-pip rpm createrepo dpkg-dev
+    sudo gem install fpm
+    sudo pip install fuel-plugin-builder
 
-None.
+2) build plugin
+    fpb --build <plugin-dir>
+    e.g.: fpb --build fastpathmetrics/src/fuel-plugin
 
-Build,  Installation & User Guide
-=================================
+3) copy plugin rpm to fuel master
+	e.g. scp fuel-plugin-collectd-ceilometer-0.9-0.9.0-1.noarch.rpm  <user>@<server-name>:~/
 
-1. https://wiki.openstack.org/wiki/Fuel
-2. https://wiki.openstack.org/wiki/Fuel/Plugins
+4) install plugin
+	fuel plugins --install <plugin-name>.rpm
+
+5) prepare fuel environment
+	on fuel dashboard, go to settings/other
+	enable collectd-ceilometer plugin with checkbox
+	save settings
+
+6) add nodes to environment
+
+7) deploy
+
+8) verify
+SSH to openstack controller node:
+    source openrc
+    ceilometer sample-list --meter interface.if_packets
+
+9) known issues
+
+a) connection aborted
+  root@node-11:~# ceilometer sample-list --meter interface.if_packets
+('Connection aborted.', BadStatusLine("''",))
+
+  workaround: sudo service ceilometer-api restart
-- 
cgit 1.2.3-korg