Deprecate allow_insecure_clients option

The allow_insecure_clients has been deprecated[1].

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

Change-Id: Icc4c4a30888b65c933b3de8d16bb01d957e05198
Closes-Bug: #1902158

manifests/init.pp

@@ -136,10 +136,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.
@@ -188,6 +184,12 @@
 #   (optional) Datasources types
 #   Defaults to $::os_service_default
 #
+# DEPRECATED PARAMETERS
+#
+# [*amqp_allow_insecure_clients*]
+#   (Optional) Accept clients using either SSL or plain TCP
+#   Defaults to undef.
+#
 class vitrage (
   $package_ensure                     = 'present',
   $default_transport_url              = $::os_service_default,
@@ -216,7 +218,6 @@ class vitrage (
   $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,
@@ -228,10 +229,17 @@ class vitrage (
   $purge_config                       = false,
   $snapshots_interval                 = $::os_service_default,
   $types                              = $::os_service_default,
+  # DEPRECATED PARAMETERS
+  $amqp_allow_insecure_clients        = undef,
 ) inherits vitrage::params {
 
   include vitrage::deps
 
+  if $amqp_allow_insecure_clients != undef {
+    warning('The amqp_allow_insecure_clients parameter is deprecated and \
+will be removed in a future release.')
+  }
+
   package { 'vitrage':
     ensure => $package_ensure,
     name   => $::vitrage::params::common_package_name,
@@ -259,22 +267,21 @@ class vitrage (
   }
 
   oslo::messaging::amqp { 'vitrage_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 { 'vitrage_config':

releasenotes/notes/deprecate_allow_insecure_clients-option-8c5f9da6b6129873.yaml

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

spec/classes/vitrage_init_spec.rb

@@ -186,7 +186,6 @@ describe 'vitrage' do
         is_expected.to contain_vitrage_config('oslo_messaging_amqp/ssl_cert_file').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_vitrage_config('oslo_messaging_amqp/ssl_key_file').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_vitrage_config('oslo_messaging_amqp/ssl_key_password').with_value('<SERVICE DEFAULT>')
-        is_expected.to contain_vitrage_config('oslo_messaging_amqp/allow_insecure_clients').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_vitrage_config('oslo_messaging_amqp/sasl_mechanisms').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_vitrage_config('oslo_messaging_amqp/sasl_config_dir').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_vitrage_config('oslo_messaging_amqp/sasl_config_name').with_value('<SERVICE DEFAULT>')