Deprecate allow_insecure_clients option

The allow_insecure_clients has been deprecated[1].

[1]https://review.opendev.org/#/c/417629/

Change-Id: Ie9f13eb225f1185e06ec528f3f9d89e075c632d4
Closes-Bug: #1902158

manifests/init.pp

@@ -158,10 +158,6 @@
 #   (Optional) Password for decrypting ssl_key_file (if encrypted)
 #   Defaults to $::os_service_default.
 #
-# [*amqp_allow_insecure_clients*]
-#   (Optional) Accept clients using either SSL or plain TCP
-#   Defaults to $::os_service_default.
-#
 # [*amqp_sasl_mechanisms*]
 #   (Optional) Space separated list of acceptable SASL mechanisms
 #   Defaults to $::os_service_default.
@@ -280,6 +276,10 @@
 #   If set, use this value for max_overflow with sqlalchemy.
 #   (Optional) Defaults to undef.
 #
+# [*amqp_allow_insecure_clients*]
+#   (Optional) Accept clients using either SSL or plain TCP
+#   Defaults to undef.
+#
 class cinder (
   $default_transport_url              = $::os_service_default,
   $rpc_response_timeout               = $::os_service_default,
@@ -312,7 +312,6 @@ class cinder (
   $amqp_ssl_cert_file                 = $::os_service_default,
   $amqp_ssl_key_file                  = $::os_service_default,
   $amqp_ssl_key_password              = $::os_service_default,
-  $amqp_allow_insecure_clients        = $::os_service_default,
   $amqp_sasl_mechanisms               = $::os_service_default,
   $amqp_sasl_config_dir               = $::os_service_default,
   $amqp_sasl_config_name              = $::os_service_default,
@@ -341,11 +340,17 @@ class cinder (
   $database_max_retries               = undef,
   $database_retry_interval            = undef,
   $database_max_overflow              = undef,
+  $amqp_allow_insecure_clients        = undef,
 ) inherits cinder::params {
 
   include cinder::deps
   include cinder::db
 
+  if $amqp_allow_insecure_clients != undef {
+    warning('The amqp_allow_insecure_clients parameter is deprecated and \
+will be removed in a future release.')
+  }
+
   if $database_connection != undef {
     warning('The database_connection parameter is deprecated and will be \
 removed in a future realse. Use cinder::db::database_connection instead')
@@ -404,22 +409,21 @@ removed in a future realse. Use cinder::db::database_max_overflow instead')
   }
 
   oslo::messaging::amqp { 'cinder_config':
-    server_request_prefix  => $amqp_server_request_prefix,
+    server_request_prefix => $amqp_server_request_prefix,
-    broadcast_prefix       => $amqp_broadcast_prefix,
+    broadcast_prefix      => $amqp_broadcast_prefix,
-    group_request_prefix   => $amqp_group_request_prefix,
+    group_request_prefix  => $amqp_group_request_prefix,
-    container_name         => $amqp_container_name,
+    container_name        => $amqp_container_name,
-    idle_timeout           => $amqp_idle_timeout,
+    idle_timeout          => $amqp_idle_timeout,
-    trace                  => $amqp_trace,
+    trace                 => $amqp_trace,
-    ssl_ca_file            => $amqp_ssl_ca_file,
+    ssl_ca_file           => $amqp_ssl_ca_file,
-    ssl_cert_file          => $amqp_ssl_cert_file,
+    ssl_cert_file         => $amqp_ssl_cert_file,
-    ssl_key_file           => $amqp_ssl_key_file,
+    ssl_key_file          => $amqp_ssl_key_file,
-    ssl_key_password       => $amqp_ssl_key_password,
+    ssl_key_password      => $amqp_ssl_key_password,
-    allow_insecure_clients => $amqp_allow_insecure_clients,
+    sasl_mechanisms       => $amqp_sasl_mechanisms,
-    sasl_mechanisms        => $amqp_sasl_mechanisms,
+    sasl_config_dir       => $amqp_sasl_config_dir,
-    sasl_config_dir        => $amqp_sasl_config_dir,
+    sasl_config_name      => $amqp_sasl_config_name,
-    sasl_config_name       => $amqp_sasl_config_name,
+    username              => $amqp_username,
-    username               => $amqp_username,
+    password              => $amqp_password,
-    password               => $amqp_password,
   }
 
   oslo::messaging::default { 'cinder_config':

releasenotes/notes/deprecate_allow_insecure_clients-option-ac8a4c45923291c0.yaml

@@ -0,0 +1,4 @@
+---
+deprecations:
+  - allow_insecure_clients option is now deprecated for removal, the
+    parameter has no effect.

spec/classes/cinder_init_spec.rb

@@ -165,7 +165,6 @@ describe 'cinder' do
         is_expected.to contain_cinder_config('oslo_messaging_amqp/ssl_cert_file').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/ssl_key_file').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/ssl_key_password').with_value('<SERVICE DEFAULT>')
-        is_expected.to contain_cinder_config('oslo_messaging_amqp/allow_insecure_clients').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/sasl_mechanisms').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/sasl_config_dir').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/sasl_config_name').with_value('<SERVICE DEFAULT>')
@@ -197,7 +196,6 @@ describe 'cinder' do
         is_expected.to contain_cinder_config('oslo_messaging_amqp/ssl_ca_file').with_value('/path/to/ca.cert')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/ssl_cert_file').with_value('/path/to/certfile')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/ssl_key_file').with_value('/path/to/key')
-        is_expected.to contain_cinder_config('oslo_messaging_amqp/allow_insecure_clients').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/sasl_mechanisms').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/sasl_config_dir').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_cinder_config('oslo_messaging_amqp/sasl_config_name').with_value('<SERVICE DEFAULT>')