Deprecate allow_insecure_clients option

The allow_insecure_clients has been deprecated[1].

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

Change-Id: I14778bcd73498800822a8250a64794bb6cfe17e1
Closes-Bug: #1902158

manifests/init.pp

@@ -246,10 +246,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.
@@ -325,6 +321,12 @@
 #   (optional) Allow plugins that support it to create VLAN transparent networks
 #   Defaults to $::os_service_default
 #
+# DEPRECATED PARAMETERS
+#
+# [*amqp_allow_insecure_clients*]
+#   (Optional) Accept clients using either SSL or plain TCP
+#   Defaults to undef.
+#
 class neutron (
   $enabled                              = true,
   $package_ensure                       = 'present',
@@ -375,7 +377,6 @@ class neutron (
   $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,
@@ -393,11 +394,18 @@ class neutron (
   $notification_transport_url           = $::os_service_default,
   $max_allowed_address_pair             = $::os_service_default,
   $vlan_transparent                     = $::os_service_default,
+  # DEPRECATED PARAMETERS
+  $amqp_allow_insecure_clients          = undef,
 ) {
 
   include neutron::deps
   include neutron::params
 
+  if $amqp_allow_insecure_clients != undef {
+    warning('The amqp_allow_insecure_clients parameter is deprecated and \
+will be removed in a future release.')
+  }
+
   if ! is_service_default($use_ssl) and ($use_ssl) {
     if is_service_default($cert_file) {
       fail('The cert_file parameter is required when use_ssl is set to true')
@@ -507,7 +515,6 @@ class neutron (
     ssl_cert_file         => $amqp_ssl_cert_file,
     ssl_key_file          => $amqp_ssl_key_file,
     ssl_key_password      => $amqp_ssl_key_password,
-    allow_insecure_clients => $amqp_allow_insecure_clients,
     sasl_mechanisms       => $amqp_sasl_mechanisms,
     sasl_config_dir       => $amqp_sasl_config_dir,
     sasl_config_name      => $amqp_sasl_config_name,

releasenotes/notes/deprecate_allow_insecure_clients-option-aa02afe6931b7d6b.yaml

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

spec/classes/neutron_init_spec.rb

@@ -409,7 +409,6 @@ describe 'neutron' do
       it { should contain_neutron_config('oslo_messaging_amqp/ssl_cert_file').with_value('<SERVICE DEFAULT>') }
       it { should contain_neutron_config('oslo_messaging_amqp/ssl_key_file').with_value('<SERVICE DEFAULT>') }
       it { should contain_neutron_config('oslo_messaging_amqp/ssl_key_password').with_value('<SERVICE DEFAULT>') }
-      it { should contain_neutron_config('oslo_messaging_amqp/allow_insecure_clients').with_value('<SERVICE DEFAULT>') }
       it { should contain_neutron_config('oslo_messaging_amqp/sasl_mechanisms').with_value('<SERVICE DEFAULT>') }
       it { should contain_neutron_config('oslo_messaging_amqp/sasl_config_dir').with_value('<SERVICE DEFAULT>') }
       it { should contain_neutron_config('oslo_messaging_amqp/sasl_config_name').with_value('<SERVICE DEFAULT>') }
@@ -437,7 +436,6 @@ describe 'neutron' do
       it { should contain_neutron_config('oslo_messaging_amqp/ssl_ca_file').with_value('/path/to/ca.cert') }
       it { should contain_neutron_config('oslo_messaging_amqp/ssl_cert_file').with_value('/path/to/certfile') }
       it { should contain_neutron_config('oslo_messaging_amqp/ssl_key_file').with_value('/path/to/key') }
-      it { should contain_neutron_config('oslo_messaging_amqp/allow_insecure_clients').with_value('<SERVICE DEFAULT>') }
       it { should contain_neutron_config('oslo_messaging_amqp/sasl_mechanisms').with_value('<SERVICE DEFAULT>') }
       it { should contain_neutron_config('oslo_messaging_amqp/sasl_config_dir').with_value('<SERVICE DEFAULT>') }
       it { should contain_neutron_config('oslo_messaging_amqp/sasl_config_name').with_value('<SERVICE DEFAULT>') }