From a940bd6c12e2568fa233c08989c2cf74ef6ee462 Mon Sep 17 00:00:00 2001
From: Volodymyr Stoiko <vstoiko@mirantis.com>
Date: Mon, 15 Aug 2016 15:39:29 +0300
Subject: [PATCH] Add class description and related docs

---
 README.md                                     | 37 +++++++++++++++++--
 deployment_scripts/puppet/manifests/deploy.pp | 14 +++++++
 .../puppet/modules/rally/manifests/config.pp  |  4 ++
 .../puppet/modules/rally/manifests/init.pp    |  8 ++++
 .../puppet/modules/rally/manifests/install.pp |  4 ++
 .../puppet/modules/rally/manifests/params.pp  |  4 ++
 6 files changed, 68 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 9abbea3..7b7750d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,35 @@
-fuel-plugin-rally
-============
+Fuel Rally plugin
+=======================
+
+Provides a separate role for deployment of the Rally benchmarking tool
+
+Building the plugin
+-------------------
+
+1. Clone the fuel-plugin repo:
+
+    ``git clone https://review.openstack.org/openstack/fuel-plugin-rally``
+
+2. Install the Fuel Plugin Builder:
+
+    ``pip install fuel-plugin-builder``
+
+3. Build Rally Fuel plugin:
+
+    ``fpb --build fuel-plugin-rally/``
+
+4. The fuel-plugin-rally-<x.x.x>.rpm plugin package will be created in the plugin folder
+   (uel-plugin-rally/).
+
+5. Move this file to the Fuel Master node with secure copy (scp):
+
+    ``scp fuel-plugin-rally/fuel-plugin-rally-<x.x.x>.rpm root@:<the_Fuel_Master_node_IP address>:/tmp``  
+    ``ssh root@:<the_Fuel_Master_node_IP address>``  
+    ``cd /tmp``
+
+6. Install the Ceilometer Rallyre plugin:
+
+    ``fuel plugins --install fuel-plugin-rally-<x.x.x>.rpm``
+
+7. Plugin is ready to be used and can be enabled on the Settings tab of the Fuel web UI.
 
-Plugin description
\ No newline at end of file
diff --git a/deployment_scripts/puppet/manifests/deploy.pp b/deployment_scripts/puppet/manifests/deploy.pp
index d921a3f..024997d 100644
--- a/deployment_scripts/puppet/manifests/deploy.pp
+++ b/deployment_scripts/puppet/manifests/deploy.pp
@@ -1,3 +1,17 @@
+#    Copyright 2015 Mirantis, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
 $plugin_name = 'fuel-plugin-rally'
 
 $rally_hash = hiera_hash($plugin_name, undef)
diff --git a/deployment_scripts/puppet/modules/rally/manifests/config.pp b/deployment_scripts/puppet/modules/rally/manifests/config.pp
index 997a777..534dcdd 100644
--- a/deployment_scripts/puppet/modules/rally/manifests/config.pp
+++ b/deployment_scripts/puppet/modules/rally/manifests/config.pp
@@ -1,3 +1,7 @@
+# Class: rally::config
+#
+# This class configures rally tool and creates existing deployment
+
 class rally::config inherits rally {
 
   $rally_config = '/etc/rally/rally.conf'
diff --git a/deployment_scripts/puppet/modules/rally/manifests/init.pp b/deployment_scripts/puppet/modules/rally/manifests/init.pp
index a750112..39561d6 100644
--- a/deployment_scripts/puppet/modules/rally/manifests/init.pp
+++ b/deployment_scripts/puppet/modules/rally/manifests/init.pp
@@ -1,3 +1,11 @@
+# == Class: rally
+#
+# Install and configure a Rally node
+#
+# === Parameters
+#
+# See below for a complete list of parameters accepted.
+
 class rally (
   $repository_url  = $rally::params::repository_url,
   $repository_tag  = $rally::params::repository_tag,
diff --git a/deployment_scripts/puppet/modules/rally/manifests/install.pp b/deployment_scripts/puppet/modules/rally/manifests/install.pp
index 6667a3c..273f9da 100644
--- a/deployment_scripts/puppet/modules/rally/manifests/install.pp
+++ b/deployment_scripts/puppet/modules/rally/manifests/install.pp
@@ -1,3 +1,7 @@
+# == Class: rally::install
+#
+# Install rally and all it's dependencies
+
 class rally::install inherits rally {
 
   $rally_installer = '/tmp/install_rally.sh'
diff --git a/deployment_scripts/puppet/modules/rally/manifests/params.pp b/deployment_scripts/puppet/modules/rally/manifests/params.pp
index a22feb9..d5eeb08 100644
--- a/deployment_scripts/puppet/modules/rally/manifests/params.pp
+++ b/deployment_scripts/puppet/modules/rally/manifests/params.pp
@@ -1,3 +1,7 @@
+# Class: rally::params
+#
+# This class configures parameters for the puppet rally module.
+
 class rally::params {
   $repository_url  = 'https://github.com/openstack/rally'
   $repository_tag  = 'master'