Increase documentation about parameters

CollectdServer, CollectdServerPort, CollectdSecurityLevel, CollectdUsername, CollectdPassword

Change-Id: I43a0aca6f620f2570bdfd88531e70611867337b0

diff --git a/environments/collectd-environment.yaml b/environments/collectd-environment.yaml
index 7780530..e40aedf 100644 (file)
--- a/environments/collectd-environment.yaml
+++ b/environments/collectd-environment.yaml
@@ -3,8 +3,36 @@ resource_registry:
 
 # parameter_defaults:
 #
-## You can specify additional plugins to load using the
-## CollectdExtraPlugins key:
+## Collectd server configuration
+#   CollectdServer: collectd0.example.com
+#
+################
+#### Other config parameters, the values shown here are the defaults
+################ 
+#
+#   CollectdServerPort: 25826 
+#   CollectdSecurityLevel: None
+#
+################
+#### If CollectdSecurityLevel is set to Encrypt or Sign
+#### the following parameters are also needed
+###############
+#
+#   CollectdUsername: user
+#   CollectdPassword: password
+#
+## CollectdDefaultPlugins, These are the default plugins used by collectd 
+#
+#   CollectdDefaultPlugins:
+#     - disk
+#     - interface
+#     - load
+#     - memory
+#     - processes
+#     - tcpconns
+# 
+## Extra plugins can be enabled by the CollectdExtraPlugins parameter:
+## All the plugins availables are:
 #
 #   CollectdExtraPlugins:
 #     - disk

diff --git a/puppet/services/metrics/collectd.yaml b/puppet/services/metrics/collectd.yaml
index da59665..b68a5ec 100644 (file)
--- a/puppet/services/metrics/collectd.yaml
+++ b/puppet/services/metrics/collectd.yaml
@@ -70,7 +70,9 @@ parameters:
   CollectdSecurityLevel:
     type: string
     description: >
-      Security level setting for remote collectd connection.
+      Security level setting for remote collectd connection. If it is
+      set to Sign or Encrypt the CollectdPassword and CollectdUsername
+      parameters need to be set.
     default: 'None'
     constraints:
       - allowed_values: