From 132158b1bb91f44495e2e441e46285d5ad1a2b6a Mon Sep 17 00:00:00 2001
From: Helena McGough <helena.mcgough@intel.com>
Date: Tue, 6 Dec 2016 22:28:42 +0000
Subject: [PATCH] Updated Documentation

 - Added Devstack GSG
 - Added sample local.conf.minimal
 - Added GSG from source

Change-Id: Ie58b99f11412627cc89916c777d700fcb80aa627
---
 .../{getting_started_guide.rst => GSG.rst}    |  0
 doc/source/devstackGSG.rst                    | 54 +++++++++++++++++++
 doc/source/examples/local.conf.minimal        | 26 +++++++++
 3 files changed, 80 insertions(+)
 rename doc/source/{getting_started_guide.rst => GSG.rst} (100%)
 create mode 100644 doc/source/devstackGSG.rst
 create mode 100644 doc/source/examples/local.conf.minimal

diff --git a/doc/source/getting_started_guide.rst b/doc/source/GSG.rst
similarity index 100%
rename from doc/source/getting_started_guide.rst
rename to doc/source/GSG.rst
diff --git a/doc/source/devstackGSG.rst b/doc/source/devstackGSG.rst
new file mode 100644
index 0000000..390d599
--- /dev/null
+++ b/doc/source/devstackGSG.rst
@@ -0,0 +1,54 @@
+===================================================
+Installing Collectd-ceilometer-plugin with Devstack
+===================================================
+
+This guide outlines how to install the collectd-ceilometer-plugin using a
+devstack deployment.
+
+Pre-requisites
+--------------
+
+- Access to the internet
+
+Installation of Devstack
+========================
+
+Follow the instructions provided in the following document to set up your own
+Devstack deployment.
+
+    http://docs.openstack.org/developer/devstack/guides/single-machine.html
+
+Once Devstack is ready to be deployed, follow the configuration steps in the
+next section to allow the installation of the plugin during deployment.
+
+Configuration of Devstack
+=========================
+
+These configuration instructions only allow for the minimal installation of
+collectd, ceilometer and the plugin. The sample local.conf provided must be
+edited to enable additional services.
+
+To configure Devstack for to install the plugin, download the sample local.conf
+from the collectd-ceilometer-plugin repo into your devstack directory.
+
+| cd devstack
+| wget https://github.com/openstack/collectd-ceilometer-plugin/blob/master/collectd_ceilometer/doc/source/examples/local.conf.minimal
+
+Edit the "HOST_IP" varible to appropriately match your environment.
+
+Build your devstack environment.
+
+| ./stack.sh
+
+Verfication of Collectd-ceilometer-plugin
+=========================================
+
+Confirm that the collectd service is up and running.
+
+| sudo systemctl status collectd.service
+
+By default collectd enables the "cpu.cpu" meter. Check that the statistics for
+this meter are being sent to ceilometer, thus confirming that collectd is
+working with ceilometer.
+
+| ceilometer sample-list --meter cpu.cpu
diff --git a/doc/source/examples/local.conf.minimal b/doc/source/examples/local.conf.minimal
new file mode 100644
index 0000000..b7e4b77
--- /dev/null
+++ b/doc/source/examples/local.conf.minimal
@@ -0,0 +1,26 @@
+[[local|localrc]]
+
+HOST_IP=<SINGLE NODE IP>
+
+VERBOSE=True
+FORCE=yes
+
+MYSQL_PASSWORD=password
+DATABASE_PASSWORD=password
+RABBIT_PASSWORD=password
+ADMIN_PASSWORD=password
+SERVICE_PASSWORD=password
+HORIZON_PASSWORD=password
+SERVICE_TOKEN=tokentoken
+
+disable_all_services
+enable_service key
+enable_service mysql
+enable_service rabbit
+enable_service dstat
+
+enable_plugin ceilometer https://github.com/openstack/ceilometer master
+enable_plugin collectd-ceilometer https://github.com/openstack/collectd-ceilometer-plugin stable/newton
+
+COLLECTD_INSTALL=True
+COLLECTD_CEILOMETER_VERBOSE=True