From: ZhongShengping <chdzsp@163.com>
Date: Fri, 3 Mar 2017 07:19:07 +0000 (+0800)
Subject: Deprecate meter_dispatcher and event_dispatcher options
X-Git-Tag: 11.0.0~15
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=8190fba40affa3fcb3177319c24975d19050fe04;p=puppet-modules%2Fpuppet-ceilometer.git

Deprecate meter_dispatcher and event_dispatcher options

1) meter_dispatcher and event_dispatcher options are now deprecated,
please use meter_dispatchers and event_dispatchers options instead.
2) Switch meter_dispatchers and event_dispatchers parameters to
$::os_service_default fact.

Change-Id: I32dcbf34160906d15c871272e5ce0eba46c02b5e
Closes-Bug: #1668817
---

diff --git a/examples/ceilometer_with_gnocchi.pp b/examples/ceilometer_with_gnocchi.pp
index 764adf0..adc3ff0 100644
--- a/examples/ceilometer_with_gnocchi.pp
+++ b/examples/ceilometer_with_gnocchi.pp
@@ -30,7 +30,7 @@ class { '::ceilometer::wsgi::apache':
 }
 
 class { '::ceilometer::collector':
-  meter_dispatcher => ['gnocchi'],
+  meter_dispatchers => ['gnocchi'],
 }
 class { '::ceilometer::dispatcher::gnocchi':
   filter_service_activity   => false,
diff --git a/manifests/collector.pp b/manifests/collector.pp
index e6041ea..c0a2c39 100644
--- a/manifests/collector.pp
+++ b/manifests/collector.pp
@@ -25,20 +25,32 @@
 #   (Optional) the ceilometer collector udp bind port.
 #   Defaults to '4952'.
 #
-# [*meter_dispatcher*]
+# [*meter_dispatchers*]
 #   (Optional) dispatcher driver(s) to process meter data.
 #   Can be an array or a string.
-#   Defaults to 'database'.
+#   Defaults to $::os_service_default.
 #
-# [*event_dispatcher*]
+# [*event_dispatchers*]
 #   (Optional) dispatcher driver(s) to process event data.
 #   Can be an array or a string.
-#   Defaults to 'database'.
+#   Defaults to $::os_service_default.
 #
 # [*collector_workers*]
 #   (Optional) Number of workers for collector service (integer value).
 #   Defaults to $::os_service_default.
 #
+# DEPRECATED PARAMETERS
+#
+# [*meter_dispatcher*]
+#   (Optional) dispatcher driver(s) to process meter data.
+#   Can be an array or a string.
+#   Defaults to undef.
+#
+# [*event_dispatcher*]
+#   (Optional) dispatcher driver(s) to process event data.
+#   Can be an array or a string.
+#   Defaults to undef.
+#
 class ceilometer::collector (
   $manage_service    = true,
   $enabled           = true,
@@ -46,8 +58,11 @@ class ceilometer::collector (
   $udp_address       = '0.0.0.0',
   $udp_port          = '4952',
   $collector_workers = $::os_service_default,
-  $meter_dispatcher  = 'database',
-  $event_dispatcher  = 'database',
+  $meter_dispatchers = $::os_service_default,
+  $event_dispatchers = $::os_service_default,
+  # DEPRECATED PARAMETERS
+  $meter_dispatcher  = undef,
+  $event_dispatcher  = undef,
 ) {
 
   include ::ceilometer::deps
@@ -59,12 +74,26 @@ class ceilometer::collector (
     fail("${udp_address} is not a valid ip and is not empty")
   }
 
+  if $meter_dispatcher {
+    warning('The meter_dispatcher parameter is deprecated, please use meter_dispatchers instead.')
+    $meter_dispatchers_real = $meter_dispatcher
+  } else {
+    $meter_dispatchers_real = $meter_dispatchers
+  }
+
+  if $event_dispatcher {
+    warning('The event_dispatcher parameter is deprecated, please use event_dispatchers instead.')
+    $event_dispatchers_real = $event_dispatcher
+  } else {
+    $event_dispatchers_real = $event_dispatchers
+  }
+
   ceilometer_config {
     'collector/udp_address':     value => $udp_address;
     'collector/udp_port':        value => $udp_port;
     'collector/workers':         value => $collector_workers;
-    'DEFAULT/meter_dispatchers': value => join(any2array($meter_dispatcher), ',');
-    'DEFAULT/event_dispatchers': value => join(any2array($event_dispatcher), ',');
+    'DEFAULT/meter_dispatchers': value => join(any2array($meter_dispatchers_real), ',');
+    'DEFAULT/event_dispatchers': value => join(any2array($event_dispatchers_real), ',');
   }
 
   ensure_resource( 'package', [$::ceilometer::params::collector_package_name],
diff --git a/releasenotes/notes/fix_dispatcher_parameters-781af23459348731.yaml b/releasenotes/notes/fix_dispatcher_parameters-781af23459348731.yaml
new file mode 100644
index 0000000..e6b3e9f
--- /dev/null
+++ b/releasenotes/notes/fix_dispatcher_parameters-781af23459348731.yaml
@@ -0,0 +1,7 @@
+---
+deprecations:
+  - meter_dispatcher and event_dispatcher options are now deprecated,
+    please use meter_dispatchers and event_dispatchers options instead.
+other:
+  - Switch meter_dispatchers and event_dispatchers parameters to
+    $::os_service_default fact.
diff --git a/spec/classes/ceilometer_collector_spec.rb b/spec/classes/ceilometer_collector_spec.rb
index 1316dfb..e5b12f2 100644
--- a/spec/classes/ceilometer_collector_spec.rb
+++ b/spec/classes/ceilometer_collector_spec.rb
@@ -52,8 +52,8 @@ describe 'ceilometer::collector' do
         is_expected.to contain_ceilometer_config('collector/udp_address').with_value( '0.0.0.0' )
         is_expected.to contain_ceilometer_config('collector/udp_port').with_value( '4952' )
         is_expected.to contain_ceilometer_config('collector/workers').with_value('<SERVICE DEFAULT>')
-        is_expected.to contain_ceilometer_config('DEFAULT/meter_dispatchers').with_value( 'database' )
-        is_expected.to contain_ceilometer_config('DEFAULT/event_dispatchers').with_value( 'database' )
+        is_expected.to contain_ceilometer_config('DEFAULT/meter_dispatchers').with_value( '<SERVICE DEFAULT>' )
+        is_expected.to contain_ceilometer_config('DEFAULT/event_dispatchers').with_value( '<SERVICE DEFAULT>' )
       end
 
       it 'installs ceilometer-collector package' do