From: Iury Gregory Melo Ferreira <iurygregory@gmail.com>
Date: Tue, 21 Jul 2015 20:26:21 +0000 (-0300)
Subject: Update Setup in Ceilometer README
X-Git-Tag: 7.0.0-mos-rc1~12
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=9529fd4e831cb9f3f37a26435bd33d8fab7521c5;p=puppet-modules%2Fpuppet-ceilometer.git

Update Setup in Ceilometer README

The actual Setup contains the example outside the box.
Add Ceilometer url
Add Beginning with Ceilometer section

Change-Id: If8e1fa9cd826d8a7a9c8a95d14854f33c76ea432
---

diff --git a/README.md b/README.md
index 2bee1c3..6c72485 100644
--- a/README.md
+++ b/README.md
@@ -33,14 +33,42 @@ Setup
 
 **What the ceilometer module affects**
 
-* ceilometer, the metering service for OpenStack
+* [Ceilometer](https://wiki.openstack.org/wiki/Ceilometer), the metering service for OpenStack
 
 ### Installing ceilometer
 
-  example% puppet module install openstack/ceilometer
+    puppet module install openstack/ceilometer
 
 ### Beginning with ceilometer
 
+To utilize the ceilometer module's functionality you will need to declare multiple resources.
+The following is a modified excerpt from the [openstack module](httpd://github.com/stackforge/puppet
+-openstack).
+This is not an exhaustive list of all the components needed. We recommend that you consult and under
+stand the [openstack module](https://github.com/stackforge/puppet-openstack) and the [core](http://d
+ocs.openstack.org) documentation to assist you in understanding the available deployment options.
+
+```puppet
+class { '::ceilometer':
+  metering_secret     => 'secrete',
+  rabbit_userid       => 'ceilometer',
+  rabbit_password     => 'an_even_bigger_secret',
+  rabbit_host         => '127.0.0.1',
+}
+class { '::ceilometer::client': }
+class { '::ceilometer::collector': }
+class { '::ceilometer::expirer': }
+class { '::ceilometer::alarm::evaluator': }
+class { '::ceilometer::alarm::notifier': }
+class { '::ceilometer::agent::central': }
+class { '::ceilometer::agent::notification': }
+class { '::ceilometer::api':
+  enabled               => true,
+  keystone_password     => 'a_big_secret',
+  keystone_identity_uri => 'http://127.0.0.1:35357/',
+}
+```
+
 Implementation
 --------------