Deprecate support for [hardware] options
authorTakashi Kajinami <tkajinam@redhat.com>
Fri, 6 May 2022 03:19:10 +0000 (12:19 +0900)
committerTakashi Kajinami <tkajinam@redhat.com>
Fri, 6 May 2022 03:20:09 +0000 (12:20 +0900)
... because these options were deprecated during the Yoga cycle when
GenericHardwareDeclarativePollster was deprecated[1].

[1] d10f6ca32fd9dfe5100cb54531adb4bba866edf8

Change-Id: I2bf6423d54234822b05a1a22f3cc29d0f7a3c1e7

manifests/init.pp
releasenotes/notes/deprecate-hardware-opts-61cf241a46a4891b.yaml [new file with mode: 0644]

index 922ad0db174baab0ce67b1b16cc6452479b9937b..89892eb36eb7ccb33f8bfe0b5e6db2c30d8645a0 100644 (file)
 #   (Optional) Password for message broker authentication
 #   Defaults to $::os_service_default.
 #
-# [*snmpd_readonly_username*]
-#   (Optional) User name for snmpd authentication
-#   Defaults to $::os_service_default.
-#
-# [*snmpd_readonly_user_password*]
-#   (Optional) Password for snmpd authentication
-#   Defaults to $::os_service_default.
-#
 # [*purge_config*]
 #   (optional) Whether to set only the specified config options
 #   in the ceilometer config.
 #   (Optional) If we should install the cache backend package.
 #   Defaults to undef
 #
+# [*snmpd_readonly_username*]
+#   (Optional) User name for snmpd authentication
+#   Defaults to undef
+#
+# [*snmpd_readonly_user_password*]
+#   (Optional) Password for snmpd authentication
+#   Defaults to undef
+#
 class ceilometer(
   $http_timeout                       = $::os_service_default,
   $max_parallel_requests              = $::os_service_default,
@@ -359,8 +359,6 @@ class ceilometer(
   $amqp_sasl_config_name              = $::os_service_default,
   $amqp_username                      = $::os_service_default,
   $amqp_password                      = $::os_service_default,
-  $snmpd_readonly_username            = $::os_service_default,
-  $snmpd_readonly_user_password       = $::os_service_default,
   $purge_config                       = false,
   $host                               = $::os_service_default,
   # DEPRECATED PARAMETERS
@@ -382,6 +380,8 @@ class ceilometer(
   $cache_hashclient_retry_delay       = undef,
   $cache_dead_timeout                 = undef,
   $manage_backend_package             = undef,
+  $snmpd_readonly_username            = undef,
+  $snmpd_readonly_user_password       = undef,
 ) {
 
   include ceilometer::deps
@@ -413,6 +413,12 @@ class ceilometer(
   }
   include ceilometer::cache
 
+  if $snmpd_readonly_username != undef or $snmpd_readonly_user_password != undef {
+    warning('The snmpd_readonly_* parameters have been deprecated.')
+  }
+  $snmpd_readonly_username_real = pick($snmpd_readonly_username, $::os_service_default)
+  $snmpd_readonly_user_password_real = pick($snmpd_readonly_user_password, $::os_service_default)
+
   group { 'ceilometer':
     ensure  => present,
     name    => 'ceilometer',
@@ -476,12 +482,12 @@ class ceilometer(
 
   # Once we got here, we can act as an honey badger on the rpc used.
   ceilometer_config {
-    'DEFAULT/http_timeout'                : value => $http_timeout;
-    'DEFAULT/max_parallel_requests'       : value => $max_parallel_requests;
-    'DEFAULT/host'                        : value => $host;
-    'publisher/telemetry_secret'          : value => $telemetry_secret, secret => true;
-    'hardware/readonly_user_name'         : value => $snmpd_readonly_username;
-    'hardware/readonly_user_password'     : value => $snmpd_readonly_user_password, secret => true;
+    'DEFAULT/http_timeout'           : value => $http_timeout;
+    'DEFAULT/max_parallel_requests'  : value => $max_parallel_requests;
+    'DEFAULT/host'                   : value => $host;
+    'publisher/telemetry_secret'     : value => $telemetry_secret, secret => true;
+    'hardware/readonly_user_name'    : value => $snmpd_readonly_username_real;
+    'hardware/readonly_user_password': value => $snmpd_readonly_user_password_real, secret => true;
   }
 
   oslo::messaging::notifications { 'ceilometer_config':
diff --git a/releasenotes/notes/deprecate-hardware-opts-61cf241a46a4891b.yaml b/releasenotes/notes/deprecate-hardware-opts-61cf241a46a4891b.yaml
new file mode 100644 (file)
index 0000000..1546fd2
--- /dev/null
@@ -0,0 +1,8 @@
+---
+deprecations:
+  - |
+    The following parameters of the ``ceilometer`` class have been deprecated
+    and will be removed in a future release.
+
+    - ``snmpd_readonly_user_name``
+    - ``snmpd_readonly_user_password``