Deprecate allow_insecure_clients option

The allow_insecure_clients has been deprecated[1].

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

Change-Id: I6f0efafb8407ea6bc2fd9f06f4bce3b60f4c5342
Closes-Bug: #1902158
This commit is contained in:
ZhongShengping 2020-11-02 14:42:04 +08:00
parent b3cf7f3df4
commit 33eb759202
3 changed files with 29 additions and 22 deletions

View File

@ -172,10 +172,6 @@
# (Optional) Password for decrypting ssl_key_file (if encrypted) # (Optional) Password for decrypting ssl_key_file (if encrypted)
# Defaults to $::os_service_default. # 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*] # [*amqp_sasl_mechanisms*]
# (Optional) Space separated list of acceptable SASL mechanisms # (Optional) Space separated list of acceptable SASL mechanisms
# Defaults to $::os_service_default. # Defaults to $::os_service_default.
@ -236,6 +232,10 @@
# (optional) If set, use this value for max_overflow with sqlalchemy. # (optional) If set, use this value for max_overflow with sqlalchemy.
# Defaults to undef. # Defaults to undef.
# #
# [*amqp_allow_insecure_clients*]
# (Optional) Accept clients using either SSL or plain TCP
# Defaults to undef.
#
class sahara( class sahara(
$package_ensure = 'present', $package_ensure = 'present',
$host = $::os_service_default, $host = $::os_service_default,
@ -274,7 +274,6 @@ class sahara(
$amqp_ssl_cert_file = $::os_service_default, $amqp_ssl_cert_file = $::os_service_default,
$amqp_ssl_key_file = $::os_service_default, $amqp_ssl_key_file = $::os_service_default,
$amqp_ssl_key_password = $::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_mechanisms = $::os_service_default,
$amqp_sasl_config_dir = $::os_service_default, $amqp_sasl_config_dir = $::os_service_default,
$amqp_sasl_config_name = $::os_service_default, $amqp_sasl_config_name = $::os_service_default,
@ -290,6 +289,7 @@ class sahara(
$database_max_retries = undef, $database_max_retries = undef,
$database_retry_interval = undef, $database_retry_interval = undef,
$database_max_overflow = undef, $database_max_overflow = undef,
$amqp_allow_insecure_clients = undef,
) { ) {
include sahara::deps include sahara::deps
@ -297,6 +297,11 @@ class sahara(
include sahara::db include sahara::db
include sahara::policy include sahara::policy
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 { if $database_connection != undef {
warning('The database_connection parameter is deprecated and will be \ warning('The database_connection parameter is deprecated and will be \
removed in a future realse. Use sahara::db::database_connection instead') removed in a future realse. Use sahara::db::database_connection instead')
@ -370,22 +375,21 @@ removed in a future realse. Use sahara::db::database_max_overflow instead')
} }
oslo::messaging::amqp { 'sahara_config': oslo::messaging::amqp { 'sahara_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,
} }
if ! is_service_default($use_ssl) and $use_ssl { if ! is_service_default($use_ssl) and $use_ssl {

View File

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

View File

@ -145,7 +145,6 @@ describe 'sahara' do
it { is_expected.to contain_sahara_config('oslo_messaging_amqp/ssl_cert_file').with_value('<SERVICE DEFAULT>') } it { is_expected.to contain_sahara_config('oslo_messaging_amqp/ssl_cert_file').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_sahara_config('oslo_messaging_amqp/ssl_key_file').with_value('<SERVICE DEFAULT>') } it { is_expected.to contain_sahara_config('oslo_messaging_amqp/ssl_key_file').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_sahara_config('oslo_messaging_amqp/ssl_key_password').with_value('<SERVICE DEFAULT>') } it { is_expected.to contain_sahara_config('oslo_messaging_amqp/ssl_key_password').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_sahara_config('oslo_messaging_amqp/allow_insecure_clients').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_sahara_config('oslo_messaging_amqp/sasl_mechanisms').with_value('<SERVICE DEFAULT>') } it { is_expected.to contain_sahara_config('oslo_messaging_amqp/sasl_mechanisms').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_sahara_config('oslo_messaging_amqp/sasl_config_dir').with_value('<SERVICE DEFAULT>') } it { is_expected.to contain_sahara_config('oslo_messaging_amqp/sasl_config_dir').with_value('<SERVICE DEFAULT>') }
it { is_expected.to contain_sahara_config('oslo_messaging_amqp/sasl_config_name').with_value('<SERVICE DEFAULT>') } it { is_expected.to contain_sahara_config('oslo_messaging_amqp/sasl_config_name').with_value('<SERVICE DEFAULT>') }