From: François Charlier <francois.charlier@enovance.com>
Date: Tue, 23 Apr 2013 09:22:31 +0000 (+0200)
Subject: Update existing puppetdoc & add missing puppetdoc
X-Git-Tag: grizzly-eol~15^2
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=50c802f37100cc71ea1959e6e0e5a5bb4e7dc4c1;p=puppet-modules%2Fpuppet-ceilometer.git

Update existing puppetdoc & add missing puppetdoc
---

diff --git a/manifests/agent/central.pp b/manifests/agent/central.pp
index 477e42c..57bb59b 100644
--- a/manifests/agent/central.pp
+++ b/manifests/agent/central.pp
@@ -1,3 +1,26 @@
+# Installs/configures the ceilometer central agent
+#
+# == Parameters
+#  [*auth_url*]
+#    Keystone URL. Optional. Defaults to 'http://localhost:5000/v2.0'
+#
+#  [*auth_region*]
+#    Keystone region. Optional. Defaults to 'RegionOne'
+#
+#  [*auth_user*]
+#    Keystone user for ceilometer. Optional. Defaults to 'ceilometer'
+#
+#  [*auth_password*]
+#    Keystone password for ceilometer. Optional. Defaults to 'password'
+#
+#  [*auth_tenant_name*]
+#    Keystone tenant name for ceilometer. Optional. Defauls to 'services'
+#
+#  [*auth_tenant_id*]
+#    Keystone tenant id for ceilometer. Optional. Defaults to ''
+#
+#  [*enabled*]
+#    Should the service be enabled. Optional. Defauls to true
 #
 class ceilometer::agent::central (
   $auth_url         = 'http://localhost:5000/v2.0',
diff --git a/manifests/agent/compute.pp b/manifests/agent/compute.pp
index 27cf6fd..c9ed60d 100644
--- a/manifests/agent/compute.pp
+++ b/manifests/agent/compute.pp
@@ -2,13 +2,33 @@
 # Include this class on all nova compute nodes
 #
 # == Parameters
-#  * auth_url: the keystone public endpoint
-#  *auth_region: the keystone region of this compute node
-#  *auth_user: the keystone user for ceilometer services
-#  *auth_password: the keystone password for ceilometer services
-#  *auth_tenant_name: the keystone tenant name for ceilometer services
-#  *auth_tenant_id (optional): the keystone tenant id for ceilometer services
-#  *enabled: should the service be started or not
+#  [*auth_url*]
+#    the keystone public endpoint
+#    Optional. Defaults to 'http://localhost:5000/v2.0'
+#
+#  [*auth_region*]
+#    the keystone region of this compute node
+#    Optional. Defaults to 'RegionOne'
+#
+#  [*auth_user*]
+#    the keystone user for ceilometer services
+#    Optional. Defaults to 'ceilometer'
+#
+#  [*auth_password*]
+#    the keystone password for ceilometer services
+#    Optional. Defaults to 'password'
+#
+#  [*auth_tenant_name*]
+#    the keystone tenant name for ceilometer services
+#    Optional. Defaults to 'services'
+#
+#  [*auth_tenant_id*]
+#    the keystone tenant id for ceilometer services.
+#    Optional. Defaults to empty.
+#
+#  [*enabled*]
+#    should the service be started or not
+#    Optional. Defaults to true
 #
 class ceilometer::agent::compute (
   $auth_url         = 'http://localhost:5000/v2.0',
diff --git a/manifests/client.pp b/manifests/client.pp
index 7bb7335..faa791a 100644
--- a/manifests/client.pp
+++ b/manifests/client.pp
@@ -2,7 +2,8 @@
 # Installs the ceilometer python library.
 #
 # == parameters
-#  * ensure - ensure state for pachage.
+#  [*ensure*]
+#    ensure state for pachage.
 #
 class ceilometer::client (
   $ensure = 'present'
diff --git a/manifests/collector.pp b/manifests/collector.pp
index b94bed1..8ba5321 100644
--- a/manifests/collector.pp
+++ b/manifests/collector.pp
@@ -1,3 +1,8 @@
+# Installs the ceilometer collector service
+#
+# == Params
+#  [*enabled*]
+#    should the service be enabled
 #
 class ceilometer::collector (
   $enabled = true,
diff --git a/manifests/db.pp b/manifests/db.pp
index 1d7627d..b256985 100644
--- a/manifests/db.pp
+++ b/manifests/db.pp
@@ -1,3 +1,10 @@
+# Configures the ceilometer database
+# This class will install the required libraries depending on the driver
+# specified in the connection_string parameter
+#
+# == Parameters
+#  [*database_connection*]
+#    the connection string. format: [driver]://[user]:[password]@[host]/[database]
 #
 class ceilometer::db (
   $database_connection = 'mysql://ceilometer:ceilometer@localhost/ceilometer'
diff --git a/manifests/init.pp b/manifests/init.pp
index 3251991..557806f 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -3,27 +3,27 @@
 #  ceilometer base package & configuration
 #
 # == parameters
-#   $metering_secret: secret key for signing messages
-#     Mandatory.
-#   $package_ensure: ensure state for package.
-#     Optional. Defaults to 'present'
-#   $verbose: should the daemons log verbose messages
-#     Optional. Defaults to 'False'
-#   $debug: should the daemons log debug messages
-#     Optional. Defaults to 'False'
-#   $rabbit_host: ip or hostname of the rabbit server
-#     Optional. Defaults to '127.0.0.1'
-#   $rabbit_port: port of the rabbit server
-#     Optional. Defaults to 5672.
-#   $rabbit_hosts: array of host:port (used with HA queues)
-#     Optional. Defaults to undef.
-#     If defined, will remove rabbit_host & rabbit_port parameters from config
-#   $rabbit_userid: user to connect to the rabbit server
-#     Optional. Defaults to 'guest'
-#   $rabbit_password: password to connect to the rabbit_server
-#     Optional. Defaults to empty string.
-#   $rabbit_virtualhost: virtualhost to use
-#     Optional. Defaults to '/'
+#  [*metering_secret*]
+#    secret key for signing messages. Mandatory.
+#  [*package_ensure*]
+#    ensure state for package. Optional. Defaults to 'present'
+#  [*verbose*]
+#    should the daemons log verbose messages. Optional. Defaults to 'False'
+#  [*debug*]
+#    should the daemons log debug messages. Optional. Defaults to 'False'
+#  [*rabbit_host*]
+#    ip or hostname of the rabbit server. Optional. Defaults to '127.0.0.1'
+#  [*rabbit_port*]
+#    port of the rabbit server. Optional. Defaults to 5672.
+#  [*rabbit_hosts*]
+#    array of host:port (used with HA queues). Optional. Defaults to undef.
+#    If defined, will remove rabbit_host & rabbit_port parameters from config
+#  [*rabbit_userid*]
+#    user to connect to the rabbit server. Optional. Defaults to 'guest'
+#  [*rabbit_password*]
+#    password to connect to the rabbit_server. Optional. Defaults to empty.
+#  [*rabbit_virtualhost*]
+#    virtualhost to use. Optional. Defaults to '/'
 #
 class ceilometer(
   $metering_secret    = false,
diff --git a/manifests/params.pp b/manifests/params.pp
index f2a2c1f..dbecc7b 100644
--- a/manifests/params.pp
+++ b/manifests/params.pp
@@ -1,4 +1,5 @@
 # Parameters for puppet-ceilometer
+#
 class ceilometer::params {
 
   $dbsync_command =