From 8a8940c87e782ad437ff8e20d8f5dbfec8ec6109 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Mon, 2 Nov 2020 14:42:04 +0800 Subject: [PATCH] Deprecate allow_insecure_clients option The allow_insecure_clients has been deprecated[1]. [1]https://review.opendev.org/#/c/417629/ Change-Id: I42c519f74d6b53570a8aaf9f4423d0a41ff4f0e4 Closes-Bug: #1902158 --- manifests/init.pp | 46 ++++++++++--------- ...ecure_clients-option-8a20653486eba410.yaml | 4 ++ spec/classes/octavia_init_spec.rb | 1 - 3 files changed, 29 insertions(+), 22 deletions(-) create mode 100644 releasenotes/notes/deprecate_allow_insecure_clients-option-8a20653486eba410.yaml diff --git a/manifests/init.pp b/manifests/init.pp index 8ebb1a89..74ab7994 100644 --- a/manifests/init.pp +++ b/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. @@ -224,6 +220,10 @@ # before error is raised. Set to -1 to specify an infinite retry count. # Defaults to undef. # +# [*amqp_allow_insecure_clients*] +# (Optional) Accept clients using either SSL or plain TCP +# Defaults to undef. +# class octavia ( $package_ensure = 'present', $default_transport_url = $::os_service_default, @@ -252,7 +252,6 @@ class octavia ( $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, @@ -273,11 +272,17 @@ class octavia ( $database_max_overflow = undef, $database_pool_timeout = undef, $database_db_max_retries = undef, + $amqp_allow_insecure_clients = undef, ) inherits octavia::params { include octavia::deps include octavia::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 octavia::db::database_connection instead') @@ -346,22 +351,21 @@ removed in a future realse. Use octavia::db::database_db_max_retries instead') } oslo::messaging::amqp { 'octavia_config': - server_request_prefix => $amqp_server_request_prefix, - broadcast_prefix => $amqp_broadcast_prefix, - group_request_prefix => $amqp_group_request_prefix, - container_name => $amqp_container_name, - idle_timeout => $amqp_idle_timeout, - trace => $amqp_trace, - ssl_ca_file => $amqp_ssl_ca_file, - 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, - username => $amqp_username, - password => $amqp_password, + server_request_prefix => $amqp_server_request_prefix, + broadcast_prefix => $amqp_broadcast_prefix, + group_request_prefix => $amqp_group_request_prefix, + container_name => $amqp_container_name, + idle_timeout => $amqp_idle_timeout, + trace => $amqp_trace, + ssl_ca_file => $amqp_ssl_ca_file, + ssl_cert_file => $amqp_ssl_cert_file, + ssl_key_file => $amqp_ssl_key_file, + ssl_key_password => $amqp_ssl_key_password, + sasl_mechanisms => $amqp_sasl_mechanisms, + sasl_config_dir => $amqp_sasl_config_dir, + sasl_config_name => $amqp_sasl_config_name, + username => $amqp_username, + password => $amqp_password, } oslo::messaging::default { 'octavia_config': diff --git a/releasenotes/notes/deprecate_allow_insecure_clients-option-8a20653486eba410.yaml b/releasenotes/notes/deprecate_allow_insecure_clients-option-8a20653486eba410.yaml new file mode 100644 index 00000000..72dff754 --- /dev/null +++ b/releasenotes/notes/deprecate_allow_insecure_clients-option-8a20653486eba410.yaml @@ -0,0 +1,4 @@ +--- +deprecations: + - allow_insecure_clients option is now deprecated for removal, the + parameter has no effect. diff --git a/spec/classes/octavia_init_spec.rb b/spec/classes/octavia_init_spec.rb index 52ba150c..d7711855 100644 --- a/spec/classes/octavia_init_spec.rb +++ b/spec/classes/octavia_init_spec.rb @@ -196,7 +196,6 @@ describe 'octavia' do is_expected.to contain_octavia_config('oslo_messaging_amqp/ssl_cert_file').with_value('') is_expected.to contain_octavia_config('oslo_messaging_amqp/ssl_key_file').with_value('') is_expected.to contain_octavia_config('oslo_messaging_amqp/ssl_key_password').with_value('') - is_expected.to contain_octavia_config('oslo_messaging_amqp/allow_insecure_clients').with_value('') is_expected.to contain_octavia_config('oslo_messaging_amqp/sasl_mechanisms').with_value('') is_expected.to contain_octavia_config('oslo_messaging_amqp/sasl_config_dir').with_value('') is_expected.to contain_octavia_config('oslo_messaging_amqp/sasl_config_name').with_value('')