aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuan Badia Payno <jbadiapa@redhat.com>2017-03-02 19:47:23 +0100
committerJuan Badia Payno <jbadiapa@redhat.com>2017-04-26 15:08:22 +0200
commit8b15fc981f3a421382b63de03016b631a3467b43 (patch)
tree7a2474fbe6740fa9aec59318ade62b3686ca6939
parent1e34fc2bcd3c87119537483edddced0d78bd0465 (diff)
Increase documentation about parameters
CollectdServer, CollectdServerPort, CollectdSecurityLevel, CollectdUsername, CollectdPassword Change-Id: I43a0aca6f620f2570bdfd88531e70611867337b0 (cherry picked from commit f209f0aa48d277ecb8300ef33225f6ce6e24a4ae)
-rw-r--r--environments/collectd-environment.yaml32
-rw-r--r--puppet/services/metrics/collectd.yaml4
2 files changed, 33 insertions, 3 deletions
diff --git a/environments/collectd-environment.yaml b/environments/collectd-environment.yaml
index 7780530..6071dcc 100644
--- 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 49b2d4c..d2d9f3d 100644
--- 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: