cache: Follow renaming of hashclient parameters

Depends-on: https://review.opendev.org/967580
Depends-on: https://review.opendev.org/967710
Change-Id: I3216bbbe382d2263fc439cdf25150afdc7d41feb
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>

manifests/cache.pp

@@ -150,7 +150,7 @@
 #   Defaults to $facts['os_service_default']
 #
 # [*tls_enabled*]
-#   (Optional) Global toggle for TLS usage when comunicating with
+#   (Optional) Global toggle for TLS usage when communicating with
 #   the caching servers.
 #   Default to $facts['os_service_default']
 #
@@ -170,7 +170,7 @@
 #
 # [*tls_keyfile*]
 #   (Optional) Path to a single file containing the client's private
-#   key in. Otherwhise the private key will be taken from the file
+#   key in. Otherwise the private key will be taken from the file
 #   specified in tls_certfile. If tls_enabled is False, this option
 #   is ignored.
 #   Default to $facts['os_service_default']
@@ -203,12 +203,12 @@
 #   the HashClient's internal mechanisms.
 #   Default to $facts['os_service_default']
 #
-# [*hashclient_retry_delay*]
+# [*hashclient_retry_timeout*]
 #   (Optional) Time in seconds that should pass between
 #   retry attempts in the HashClient's internal mechanisms.
 #   Default to $facts['os_service_default']
 #
-# [*dead_timeout*]
+# [*hashclient_dead_timeout*]
 #   (Optional) Time in seconds before attempting to add a node
 #   back in the pool in the HashClient's internal mechanisms.
 #   Default to $facts['os_service_default']
@@ -217,6 +217,18 @@
 #   (Optional) Whether to install the backend package for the cache.
 #   Defaults to true
 #
+# DEPRECATED PARAMETERS
+#
+# [*hashclient_retry_delay*]
+#   (Optional) Time in seconds that should pass between
+#   retry attempts in the HashClient's internal mechanisms.
+#   Default to undef
+#
+# [*dead_timeout*]
+#   (Optional) Time in seconds before attempting to add a node
+#   back in the pool in the HashClient's internal mechanisms.
+#   Default to undef
+#
 class zaqar::cache (
   $config_prefix                        = $facts['os_service_default'],
   $expiration_time                      = $facts['os_service_default'],
@@ -255,9 +267,11 @@ class zaqar::cache (
   $retry_attempts                       = $facts['os_service_default'],
   $retry_delay                          = $facts['os_service_default'],
   $hashclient_retry_attempts            = $facts['os_service_default'],
-  $hashclient_retry_delay               = $facts['os_service_default'],
-  $dead_timeout                         = $facts['os_service_default'],
+  $hashclient_retry_timeout             = $facts['os_service_default'],
+  $hashclient_dead_timeout              = $facts['os_service_default'],
   Boolean $manage_backend_package       = true,
+  $hashclient_retry_delay               = undef,
+  $dead_timeout                         = undef,
 ) {
   include zaqar::deps
 
@@ -299,9 +313,11 @@ class zaqar::cache (
     retry_attempts                       => $retry_attempts,
     retry_delay                          => $retry_delay,
     hashclient_retry_attempts            => $hashclient_retry_attempts,
+    hashclient_retry_timeout             => $hashclient_retry_timeout,
+    hashclient_dead_timeout              => $hashclient_dead_timeout,
+    manage_backend_package               => $manage_backend_package,
     hashclient_retry_delay               => $hashclient_retry_delay,
     dead_timeout                         => $dead_timeout,
-    manage_backend_package               => $manage_backend_package,
   }
 
   # all cache settings should be applied and all packages should be installed

releasenotes/notes/cache-rename-hashclient-params-59ff18d679bb5a8f.yaml

@@ -0,0 +1,8 @@
+---
+deprecations:
+  - |
+    The ``zaqar::cache::hashclient_retry_delay`` parameter was deprecated
+    in favor of the new ``hashclient_retry_timeout`` parameter.
+  - |
+    The ``zaqar::cache::dead_timeout`` parameter was deprecated in favor
+    of the new ``hashclient_dead_timeout`` parameter.

spec/classes/zaqar_cache_spec.rb

@@ -48,9 +48,11 @@ describe 'zaqar::cache' do
           :retry_attempts                       => '<SERVICE DEFAULT>',
           :retry_delay                          => '<SERVICE DEFAULT>',
           :hashclient_retry_attempts            => '<SERVICE DEFAULT>',
-          :hashclient_retry_delay               => '<SERVICE DEFAULT>',
-          :dead_timeout                         => '<SERVICE DEFAULT>',
+          :hashclient_retry_timeout             => '<SERVICE DEFAULT>',
+          :hashclient_dead_timeout              => '<SERVICE DEFAULT>',
           :manage_backend_package               => true,
+          :hashclient_retry_delay               => nil,
+          :dead_timeout                         => nil,
         )
       end
     end
@@ -90,9 +92,11 @@ describe 'zaqar::cache' do
           :retry_attempts                       => 2,
           :retry_delay                          => 0,
           :hashclient_retry_attempts            => 2,
-          :hashclient_retry_delay               => 1,
-          :dead_timeout                         => 60,
+          :hashclient_retry_timeout             => 1,
+          :hashclient_dead_timeout              => 60,
           :manage_backend_package               => false,
+          :hashclient_retry_delay               => 3,
+          :dead_timeout                         => 61,
         }
       end
 
@@ -135,9 +139,11 @@ describe 'zaqar::cache' do
           :retry_attempts                       => 2,
           :retry_delay                          => 0,
           :hashclient_retry_attempts            => 2,
-          :hashclient_retry_delay               => 1,
-          :dead_timeout                         => 60,
+          :hashclient_retry_timeout             => 1,
+          :hashclient_dead_timeout              => 60,
           :manage_backend_package               => false,
+          :hashclient_retry_delay               => 3,
+          :dead_timeout                         => 61,
         )
       end
     end