From b9aa60bb683bc160a5a5db99c004e0500751fd36 Mon Sep 17 00:00:00 2001
From: Martin Magr <mmagr@redhat.com>
Date: Mon, 1 Oct 2018 16:02:58 +0200
Subject: [PATCH] Collectd documentation refactor

This patch is adding missing documentation of two collectd write plugins
in the collectd-evnironment.yaml and fixes deprecated configuration keys
for metrics_qdr in metrics-collectd-qdr.yaml.

Change-Id: I7d41bbf1ca46114cfa5f1784baa8da03aee9fcab
---
 environments/collectd-environment.yaml | 94 +++++++++++++++++++++-----
 environments/metrics-collectd-qdr.yaml |  4 +-
 2 files changed, 78 insertions(+), 20 deletions(-)

diff --git a/environments/collectd-environment.yaml b/environments/collectd-environment.yaml
index b22a1db95c..6fffcbab73 100644
--- a/environments/collectd-environment.yaml
+++ b/environments/collectd-environment.yaml
@@ -3,25 +3,11 @@ resource_registry:
 
 # parameter_defaults:
 #
-## Collectd server configuration
-#   CollectdServer: collectd0.example.com
-#
 ################
-#### Other config parameters, the values shown here are the defaults
+#### Basic Collectd configuration
 ################
 #
-#   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
+## These are the default plugins used by collectd
 #
 #   CollectdDefaultPlugins:
 #     - disk
@@ -38,9 +24,81 @@ resource_registry:
 #     - disk
 #     - df
 #
+## To choose write plugin use below parameter:
+#
+#   CollectdConnectionType: 'gnocchi' (default) / 'amqp1' / 'network'
+#
+################
+#### Collectd with network write plugin
+################
+#
+#   CollectdServer: collectd0.example.com
+#   CollectdServerPort: 25826
+#   CollectdSecurityLevel: None
+#
+## If CollectdSecurityLevel is set to Encrypt or Sign the following parameters
+## are also needed
+#
+#   CollectdUsername: user
+#   CollectdPassword: password
+#
+################
+#### Collectd with gnocchi write plugin
+################
+#
+#   CollectdGnocchiResourceType: collectd
+#   CollectdGnocchiBatchSize: 10
+#   CollectdGnocchiAuthMode: 'basic' / 'keystone' (default)
+#
+## By default collectd with gnocchi write plugin is configured to send metrics
+## to gnocchi instance running on overcloud nodes. You can override this
+## behaviour with below parameters.
+#
+## Parameters for basic authentication
+#   CollectdGnocchiProtocol: 'http'
+#   CollectdGnocchiServer: <IP>
+#   CollectdGnocchiPort: 8041
+#   CollectdGnocchiUser: admin
+#
+## Parameters for Keystone authentication
+#   CollectdGnocchiKeystoneAuthUrl
+#   CollectdGnocchiKeystoneUserName
+#   CollectdGnocchiKeystoneUserId
+#   CollectdGnocchiKeystonePassword
+#   CollectdGnocchiKeystoneProjectId
+#   CollectdGnocchiKeystoneProjectName
+#   CollectdGnocchiKeystoneUserDomainId
+#   CollectdGnocchiKeystoneUserDomainName
+#   CollectdGnocchiKeystoneProjectDomainId
+#   CollectdGnocchiKeystoneProjectDomainName
+#   CollectdGnocchiKeystoneRegionName
+#   CollectdGnocchiKeystoneInterface
+#   CollectdGnocchiKeystoneEndpoint
+#
+################
+#### Collectd with amqp1 write plugin
+################
+#
+## By default collectd uses local edge qdrouterd running on each overcloud node.
+## You can override this behaviour with following parameters.
+#
+#   CollectdAmqpHost: <IP>
+#   CollectdAmqpPort: 5666
+#   CollectdAmqpUser: guest
+#   CollectdAmqpPassword: guest
+#   CollectdAmqpTransportName: metrics
+#   CollectdAmqpAddress: collectd
+#   CollectdAmqpInstances: {}
+#   CollectdAmqpRetryDelay: 1
+#   CollectdAmqpInterval: 30
+#
+################
+#### Tip
+################
+#
 ## You can use ExtraConfig (or one of the related *ExtraConfig keys)
-## to configure collectd.  See the documentation for puppet-collectd at
-## https://github.com/voxpupuli/puppet-collectd for details.
+## to additionaly configure collectd. For details see the documentation
+## for puppet-collectd at https://github.com/voxpupuli/puppet-collectd .
 #
 #   ExtraConfig:
 #     collectd::plugin::disk::disks:
diff --git a/environments/metrics-collectd-qdr.yaml b/environments/metrics-collectd-qdr.yaml
index bcc8fb0ebd..a785d3be57 100644
--- a/environments/metrics-collectd-qdr.yaml
+++ b/environments/metrics-collectd-qdr.yaml
@@ -19,9 +19,9 @@ parameter_defaults:
       format: JSON
       presettle: false
   #MetricsQdrConnectors:
-  #  - addr: IP1
+  #  - host: IP1
   #    port: 1234
   #    role: inter-router
-  #  - addr: IP2
+  #  - host: IP2
   #    port: 5678
   #    role: inter-router