From 84019cd78c509fcef91d6dc4ffd133f513004982 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Sun, 3 Nov 2024 09:18:00 +0900
Subject: [PATCH] Add support for [cache] backend_expiration_time

Depends-on: https://review.opendev.org/933978
Change-Id: Ie733f700dd815041b5d34666ed4c56515a2a1d30
---
 manifests/cache.pp                                         | 7 +++++++
 .../cache-backend-expiration-time-9f293679ac6f6d4f.yaml    | 5 +++++
 spec/classes/ceilometer_cache_spec.rb                      | 3 +++
 3 files changed, 15 insertions(+)
 create mode 100644 releasenotes/notes/cache-backend-expiration-time-9f293679ac6f6d4f.yaml

diff --git a/manifests/cache.pp b/manifests/cache.pp
index 95391440..73482617 100644
--- a/manifests/cache.pp
+++ b/manifests/cache.pp
@@ -18,6 +18,11 @@
 #   (integer value)
 #   Defaults to $facts['os_service_default']
 #
+# [*backend_expiration_time*]
+#   (optional) expiration time in cache backend to purge expired records
+#   automatically.
+#   defaults to $facts['os_service_default']
+#
 # [*backend*]
 #   (Optional) Dogpile.cache backend module. It is recommended that
 #   Memcache with pooling (oslo_cache.memcache_pool) or Redis
@@ -215,6 +220,7 @@
 class ceilometer::cache (
   $config_prefix                        = $facts['os_service_default'],
   $expiration_time                      = $facts['os_service_default'],
+  $backend_expiration_time              = $facts['os_service_default'],
   $backend                              = $facts['os_service_default'],
   $backend_argument                     = $facts['os_service_default'],
   $proxies                              = $facts['os_service_default'],
@@ -259,6 +265,7 @@ class ceilometer::cache (
   oslo::cache { 'ceilometer_config':
     config_prefix                        => $config_prefix,
     expiration_time                      => $expiration_time,
+    backend_expiration_time              => $backend_expiration_time,
     backend                              => $backend,
     backend_argument                     => $backend_argument,
     proxies                              => $proxies,
diff --git a/releasenotes/notes/cache-backend-expiration-time-9f293679ac6f6d4f.yaml b/releasenotes/notes/cache-backend-expiration-time-9f293679ac6f6d4f.yaml
new file mode 100644
index 00000000..96b51f2b
--- /dev/null
+++ b/releasenotes/notes/cache-backend-expiration-time-9f293679ac6f6d4f.yaml
@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    The new ``ceilometer::cache::backend_expiration_time`` parameter has been
+    added.
diff --git a/spec/classes/ceilometer_cache_spec.rb b/spec/classes/ceilometer_cache_spec.rb
index 7de9e473..49ab36d7 100644
--- a/spec/classes/ceilometer_cache_spec.rb
+++ b/spec/classes/ceilometer_cache_spec.rb
@@ -13,6 +13,7 @@ describe 'ceilometer::cache' do
         is_expected.to contain_oslo__cache('ceilometer_config').with(
           :config_prefix                        => '<SERVICE DEFAULT>',
           :expiration_time                      => '<SERVICE DEFAULT>',
+          :backend_expiration_time              => '<SERVICE DEFAULT>',
           :backend                              => '<SERVICE DEFAULT>',
           :backend_argument                     => '<SERVICE DEFAULT>',
           :proxies                              => '<SERVICE DEFAULT>',
@@ -59,6 +60,7 @@ describe 'ceilometer::cache' do
         {
           :config_prefix                        => 'prefix',
           :expiration_time                      => 3600,
+          :backend_expiration_time              => 7200,
           :backend                              => 'oslo_cache.memcache_pool',
           :proxies                              => ['proxy01:8888', 'proxy02:8888'],
           :enabled                              => true,
@@ -98,6 +100,7 @@ describe 'ceilometer::cache' do
         is_expected.to contain_oslo__cache('ceilometer_config').with(
           :config_prefix                        => 'prefix',
           :expiration_time                      => 3600,
+          :backend_expiration_time              => 7200,
           :backend                              => 'oslo_cache.memcache_pool',
           :backend_argument                     => '<SERVICE DEFAULT>',
           :proxies                              => ['proxy01:8888', 'proxy02:8888'],