From: Jake Yip <jake.yip@unimelb.edu.au>
Date: Thu, 29 Jun 2017 06:43:32 +0000 (+1000)
Subject: Deprecate store_events config option
X-Git-Tag: 11.2.0~6^2
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=d86e1f57fd8898f7e205967bc1dbc9dfb1e7b0a3;p=puppet-modules%2Fpuppet-ceilometer.git

Deprecate store_events config option

The store_events option has been removed since Newton

Depends-On: I5a906684f6371b0548ac08cacc13aa238f780f78
Change-Id: I0a997d0c7076d2133d20b268b47f0c867a15f106
---

diff --git a/manifests/agent/notification.pp b/manifests/agent/notification.pp
index 35e2219..b5a1c81 100644
--- a/manifests/agent/notification.pp
+++ b/manifests/agent/notification.pp
@@ -36,10 +36,6 @@
 #   (Optional) Acknowledge message when event persistence fails.
 #   Defaults to true.
 #
-# [*store_events*]
-#   (Optional) Save event details.
-#   Defaults to false.
-#
 # [*disable_non_metric_meters*]
 #   (Optional) Disable or enable the collection of non-metric meters.
 #   Default to $::os_service_default.
@@ -77,11 +73,16 @@
 #   Defaults to ['gnocchi://'], If you are using collector
 #   override this to notifier:// instead.
 #
+# === DEPRECATED PARAMETERS:
+# [*store_events*]
+#   (Optional) Save event details.
+#   This option has been removed since Newton.
+#
+
 class ceilometer::agent::notification (
   $manage_service            = true,
   $enabled                   = true,
   $ack_on_event_error        = true,
-  $store_events              = false,
   $disable_non_metric_meters = $::os_service_default,
   $notification_workers      = $::os_service_default,
   $messaging_urls            = $::os_service_default,
@@ -90,11 +91,16 @@ class ceilometer::agent::notification (
   $event_pipeline_publishers = ['gnocchi://'],
   $manage_pipeline           = false,
   $pipeline_publishers       = ['gnocchi://'],
+  $store_events              = undef,
 ) {
 
   include ::ceilometer::deps
   include ::ceilometer::params
 
+  if $store_events != undef {
+    warning('store_events has been removed since Newton.')
+  }
+
   ensure_resource('package', [$::ceilometer::params::agent_notification_package_name],
     {
       ensure => $package_ensure,
diff --git a/releasenotes/notes/remove_store_events_option-b8158e3c03ec5190.yaml b/releasenotes/notes/remove_store_events_option-b8158e3c03ec5190.yaml
new file mode 100644
index 0000000..b3bc06f
--- /dev/null
+++ b/releasenotes/notes/remove_store_events_option-b8158e3c03ec5190.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - Deprecate store_events option.
+    This option has been removed from ceilometer since Newton.
diff --git a/spec/classes/ceilometer_agent_notification_spec.rb b/spec/classes/ceilometer_agent_notification_spec.rb
index 1c1bbae..ac75770 100644
--- a/spec/classes/ceilometer_agent_notification_spec.rb
+++ b/spec/classes/ceilometer_agent_notification_spec.rb
@@ -29,8 +29,7 @@ describe 'ceilometer::agent::notification' do
   let :params do
     { :manage_service     => true,
       :enabled            => true,
-      :ack_on_event_error => true,
-      :store_events       => false }
+      :ack_on_event_error => true }
   end
 
   shared_examples_for 'ceilometer-agent-notification' do
@@ -48,7 +47,6 @@ describe 'ceilometer::agent::notification' do
     it 'configures notifications parameters in ceilometer.conf' do
       is_expected.to contain_ceilometer_config('notification/workers').with_value('<SERVICE DEFAULT>')
       is_expected.to contain_ceilometer_config('notification/ack_on_event_error').with_value( params[:ack_on_event_error] )
-      is_expected.to contain_ceilometer_config('notification/store_events').with_value( params[:store_events] )
       is_expected.to contain_ceilometer_config('notification/disable_non_metric_meters').with_value('<SERVICE DEFAULT>')
     end