Rename the redundant worker parameter

Change-Id: I3e8924c95655e12494382130b8edeb0f47e0fb95

diff --git a/manifests/agent/notification.pp b/manifests/agent/notification.pp
index 032c1bea19214395f5393b128277563cf128d170..0c2eaadbd13e50f11f4708251deec95ee5824460 100644 (file)
--- a/manifests/agent/notification.pp
+++ b/manifests/agent/notification.pp
@@ -40,7 +40,7 @@
 #   (Optional) Disable or enable the collection of non-metric meters.
 #   Default to $::os_service_default.
 #
-# [*notification_workers*]
+# [*workers*]
 #   (Optional) Number of workers for notification service (integer value).
 #   Defaults to $::os_service_default.
 #
@@ -83,12 +83,18 @@
 #   Defaults to ['gnocchi://'], If you are using collector
 #   override this to notifier:// instead.
 #
+# DEPRECATED PARAMETERS
+#
+# [*notification_workers*]
+#   (Optional) Number of workers for notification service (integer value).
+#   Defaults to $::os_service_default.
+#
 class ceilometer::agent::notification (
   $manage_service            = true,
   $enabled                   = true,
   $ack_on_event_error        = $::os_service_default,
   $disable_non_metric_meters = $::os_service_default,
-  $notification_workers      = $::os_service_default,
+  $workers                   = $::os_service_default,
   $messaging_urls            = $::os_service_default,
   $package_ensure            = 'present',
   $manage_event_pipeline     = false,
@@ -97,11 +103,20 @@ class ceilometer::agent::notification (
   $manage_pipeline           = false,
   $pipeline_publishers       = ['gnocchi://'],
   $pipeline_config           = undef,
+  # DEPRECATED PARAMETERS
+  $notification_workers      = undef,
 ) {
 
   include ceilometer::deps
   include ceilometer::params
 
+  if $notification_workers != undef {
+    warning('The notification_workers parameter is deprecated. Use the workers parameter instead')
+    $workers_real = $notification_workers
+  } else {
+    $workers_real = $workers
+  }
+
   ensure_resource('package', [$::ceilometer::params::agent_notification_package_name],
     {
       ensure => $package_ensure,
@@ -171,7 +186,7 @@ class ceilometer::agent::notification (
   ceilometer_config {
     'notification/ack_on_event_error'       : value => $ack_on_event_error;
     'notification/disable_non_metric_meters': value => $disable_non_metric_meters;
-    'notification/workers'                  : value => $notification_workers;
+    'notification/workers'                  : value => $workers;
     'notification/messaging_urls'           : value => $messaging_urls, secret => true;
   }
 }

diff --git a/releasenotes/notes/notification-workers-6a09b1f65a37ab4b.yaml b/releasenotes/notes/notification-workers-6a09b1f65a37ab4b.yaml
new file mode 100644 (file)
index 0000000..606c0d7
--- /dev/null
+++ b/releasenotes/notes/notification-workers-6a09b1f65a37ab4b.yaml
@@ -0,0 +1,6 @@
+---
+deprecations:
+  - |
+    The ``ceilometer::notification::notification_workers`` parameter has been
+    deprecated and will be removed in a future release. Use the ``workers``
+    option instead.

diff --git a/spec/classes/ceilometer_agent_notification_spec.rb b/spec/classes/ceilometer_agent_notification_spec.rb
index b47a65b7c81a20e34b8cd840efb9a03856d2e6e6..39bbbacc79fe9161100b0e6bae5259de09659b8e 100644 (file)
--- a/spec/classes/ceilometer_agent_notification_spec.rb
+++ b/spec/classes/ceilometer_agent_notification_spec.rb
@@ -262,6 +262,14 @@ sinks:
         it { is_expected.not_to contain_file('pipeline') }
     end
 
+    context 'with workers' do
+      before do
+        params.merge!( :workers => 4 )
+      end
+
+      it { is_expected.to contain_ceilometer_config('notification/workers').with_value(4) }
+    end
+
     context 'with custom ack_on_event_error' do
       before do
         params.merge!( :ack_on_event_error => true )