From b50b6a085a1464d92a7f7b6cac8db5584f3809ca Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Sun, 28 Apr 2019 15:00:10 +0800 Subject: [PATCH] Deprecate idle_timeout option The idle_timeout parameter is deprecated, use connection_recycle_time instead[1]. [1]https://review.opendev.org/#/c/334182/ Change-Id: Ic78f6dbd66ceb7646c65268444721798454ac73f Depends-On: https://review.opendev.org/656106/ Closes-Bug: #1826692 --- manifests/db.pp | 54 ++++++++++++------- manifests/inspector/db.pp | 54 ++++++++++++------- ...le_timeout_parameter-bb14a0f10a816033.yaml | 4 ++ spec/classes/ironic_db_spec.rb | 54 +++++++++---------- spec/classes/ironic_init_spec.rb | 2 +- spec/classes/ironic_inspector_db_spec.rb | 54 +++++++++---------- 6 files changed, 127 insertions(+), 95 deletions(-) create mode 100644 releasenotes/notes/deprecate_idle_timeout_parameter-bb14a0f10a816033.yaml diff --git a/manifests/db.pp b/manifests/db.pp index a2092c41..eb71c1e6 100644 --- a/manifests/db.pp +++ b/manifests/db.pp @@ -8,7 +8,7 @@ # Url used to connect to database. # (Optional) Defaults to 'sqlite:////var/lib/ironic/ovs.sqlite'. # -# [*database_idle_timeout*] +# [*database_connection_recycle_time*] # Timeout when db connections should be reaped. # (Optional) Defaults to $::os_service_default # @@ -42,24 +42,38 @@ # (Optional) If set, use this value for pool_timeout with SQLAlchemy. # Defaults to $::os_service_default # +# DEPRECATED PARAMETERS +# +# [*database_idle_timeout*] +# Timeout when db connections should be reaped. +# Defaults to undef. +# class ironic::db ( - $database_connection = 'sqlite:////var/lib/ironic/ovs.sqlite', - $database_idle_timeout = $::os_service_default, - $database_max_retries = $::os_service_default, - $database_retry_interval = $::os_service_default, - $database_min_pool_size = $::os_service_default, - $database_max_pool_size = $::os_service_default, - $database_max_overflow = $::os_service_default, - $database_db_max_retries = $::os_service_default, - $database_pool_timeout = $::os_service_default, + $database_connection = 'sqlite:////var/lib/ironic/ovs.sqlite', + $database_connection_recycle_time = $::os_service_default, + $database_max_retries = $::os_service_default, + $database_retry_interval = $::os_service_default, + $database_min_pool_size = $::os_service_default, + $database_max_pool_size = $::os_service_default, + $database_max_overflow = $::os_service_default, + $database_db_max_retries = $::os_service_default, + $database_pool_timeout = $::os_service_default, + # DEPRECATED PARAMETERS + $database_idle_timeout = undef, ) { include ::ironic::deps + if $database_idle_timeout { + warning('The database_idle_timeout parameter is deprecated. Please use \ +database_connection_recycle_time instead.') + } + # NOTE(spredzy): In order to keep backward compatibility we rely on the pick function # to use ironic:: if ironic::db:: isn't specified. $database_connection_real = pick($::ironic::database_connection, $database_connection) - $database_idle_timeout_real = pick($::ironic::database_idle_timeout, $database_idle_timeout) + $database_connection_recycle_time_real = pick($::ironic::database_idle_timeout, $database_idle_timeout, + $database_connection_recycle_time) $database_max_retries_real = pick($::ironic::database_max_retries, $database_max_retries) $database_retry_interval_real = pick($::ironic::database_retry_interval, $database_retry_interval) $database_min_pool_size_real = pick($::ironic::database_min_pool_size, $database_min_pool_size) @@ -70,15 +84,15 @@ class ironic::db ( ['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?']) oslo::db { 'ironic_config': - connection => $database_connection_real, - idle_timeout => $database_idle_timeout_real, - min_pool_size => $database_min_pool_size_real, - max_pool_size => $database_max_pool_size_real, - max_retries => $database_max_retries_real, - retry_interval => $database_retry_interval_real, - max_overflow => $database_max_overflow_real, - db_max_retries => $database_db_max_retries, - pool_timeout => $database_pool_timeout, + connection => $database_connection_real, + connection_recycle_time => $database_connection_recycle_time_real, + min_pool_size => $database_min_pool_size_real, + max_pool_size => $database_max_pool_size_real, + max_retries => $database_max_retries_real, + retry_interval => $database_retry_interval_real, + max_overflow => $database_max_overflow_real, + db_max_retries => $database_db_max_retries, + pool_timeout => $database_pool_timeout, } } diff --git a/manifests/inspector/db.pp b/manifests/inspector/db.pp index c358915a..41ccfc8c 100644 --- a/manifests/inspector/db.pp +++ b/manifests/inspector/db.pp @@ -8,7 +8,7 @@ # Url used to connect to database. # (Optional) Defaults to 'sqlite:////var/lib/ironic-inspector/inspector.sqlite'. # -# [*database_idle_timeout*] +# [*database_connection_recycle_time*] # Timeout when db connections should be reaped. # (Optional) Defaults to $::os_service_default # @@ -42,35 +42,49 @@ # (Optional) If set, use this value for pool_timeout with SQLAlchemy. # Defaults to $::os_service_default # +# DEPRECATED PARAMETERS +# +# [*database_idle_timeout*] +# Timeout when db connections should be reaped. +# Defaults to undef. +# class ironic::inspector::db ( - $database_connection = 'sqlite:////var/lib/ironic-inspector/inspector.sqlite', - $database_idle_timeout = $::os_service_default, - $database_max_retries = $::os_service_default, - $database_db_max_retries = $::os_service_default, - $database_retry_interval = $::os_service_default, - $database_min_pool_size = $::os_service_default, - $database_max_pool_size = $::os_service_default, - $database_max_overflow = $::os_service_default, - $database_pool_timeout = $::os_service_default, + $database_connection = 'sqlite:////var/lib/ironic-inspector/inspector.sqlite', + $database_connection_recycle_time = $::os_service_default, + $database_max_retries = $::os_service_default, + $database_db_max_retries = $::os_service_default, + $database_retry_interval = $::os_service_default, + $database_min_pool_size = $::os_service_default, + $database_max_pool_size = $::os_service_default, + $database_max_overflow = $::os_service_default, + $database_pool_timeout = $::os_service_default, + # DEPRECATED PARAMETERS + $database_idle_timeout = undef, ) { include ::ironic::params - $database_connection_real = pick($::ironic::inspector::db_connection, $database_connection) + if $database_idle_timeout { + warning('The database_idle_timeout parameter is deprecated. Please use \ +database_connection_recycle_time instead.') + } + + $database_connection_recycle_time_real = pick($database_idle_timeout, $database_connection_recycle_time) + $database_connection_real = pick($::ironic::inspector::db_connection, $database_connection) validate_legacy(Oslo::Dbconn, 'validate_re', $database_connection_real, ['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?']) oslo::db { 'ironic_inspector_config': - connection => $database_connection_real, - idle_timeout => $database_idle_timeout, - min_pool_size => $database_min_pool_size, - max_pool_size => $database_max_pool_size, - max_retries => $database_max_retries, - db_max_retries => $database_max_retries, - retry_interval => $database_retry_interval, - max_overflow => $database_max_overflow, - pool_timeout => $database_pool_timeout, + connection => $database_connection_real, + connection_recycle_time => $database_connection_recycle_time_real, + min_pool_size => $database_min_pool_size, + max_pool_size => $database_max_pool_size, + max_retries => $database_max_retries, + db_max_retries => $database_max_retries, + retry_interval => $database_retry_interval, + max_overflow => $database_max_overflow, + pool_timeout => $database_pool_timeout, } } diff --git a/releasenotes/notes/deprecate_idle_timeout_parameter-bb14a0f10a816033.yaml b/releasenotes/notes/deprecate_idle_timeout_parameter-bb14a0f10a816033.yaml new file mode 100644 index 00000000..09e76c41 --- /dev/null +++ b/releasenotes/notes/deprecate_idle_timeout_parameter-bb14a0f10a816033.yaml @@ -0,0 +1,4 @@ +--- +deprecations: + - database_idle_timeout is deprecated and will be removed in a future + release. Please use database_connection_recycle_time instead. diff --git a/spec/classes/ironic_db_spec.rb b/spec/classes/ironic_db_spec.rb index e286f72a..eaad4b69 100644 --- a/spec/classes/ironic_db_spec.rb +++ b/spec/classes/ironic_db_spec.rb @@ -6,45 +6,45 @@ describe 'ironic::db' do it { should contain_class('ironic::deps') } it { should contain_oslo__db('ironic_config').with( - :db_max_retries => '', - :connection => 'sqlite:////var/lib/ironic/ovs.sqlite', - :idle_timeout => '', - :min_pool_size => '', - :max_pool_size => '', - :max_retries => '', - :pool_timeout => '', - :retry_interval => '', - :max_overflow => '', + :db_max_retries => '', + :connection => 'sqlite:////var/lib/ironic/ovs.sqlite', + :connection_recycle_time => '', + :min_pool_size => '', + :max_pool_size => '', + :max_retries => '', + :pool_timeout => '', + :retry_interval => '', + :max_overflow => '', )} end context 'with specific parameters' do let :params do { - :database_connection => 'mysql+pymysql://ironic:ironic@localhost/ironic', - :database_idle_timeout => '3601', - :database_min_pool_size => '2', - :database_max_pool_size => '21', - :database_max_retries => '11', - :database_pool_timeout => '21', - :database_max_overflow => '21', - :database_retry_interval => '11', - :database_db_max_retries => '-1', + :database_connection => 'mysql+pymysql://ironic:ironic@localhost/ironic', + :database_connection_recycle_time => '3601', + :database_min_pool_size => '2', + :database_max_pool_size => '21', + :database_max_retries => '11', + :database_pool_timeout => '21', + :database_max_overflow => '21', + :database_retry_interval => '11', + :database_db_max_retries => '-1', } end it { should contain_class('ironic::deps') } it { should contain_oslo__db('ironic_config').with( - :db_max_retries => '-1', - :connection => 'mysql+pymysql://ironic:ironic@localhost/ironic', - :idle_timeout => '3601', - :min_pool_size => '2', - :max_pool_size => '21', - :max_retries => '11', - :retry_interval => '11', - :max_overflow => '21', - :pool_timeout => '21', + :db_max_retries => '-1', + :connection => 'mysql+pymysql://ironic:ironic@localhost/ironic', + :connection_recycle_time => '3601', + :min_pool_size => '2', + :max_pool_size => '21', + :max_retries => '11', + :retry_interval => '11', + :max_overflow => '21', + :pool_timeout => '21', )} end end diff --git a/spec/classes/ironic_init_spec.rb b/spec/classes/ironic_init_spec.rb index 5751c8b8..cee0b7ff 100644 --- a/spec/classes/ironic_init_spec.rb +++ b/spec/classes/ironic_init_spec.rb @@ -96,7 +96,7 @@ describe 'ironic' do it 'should perform default database configuration' do is_expected.to contain_ironic_config('database/connection').with_value(params[:database_connection]) is_expected.to contain_ironic_config('database/max_retries').with_value(params[:database_max_retries]) - is_expected.to contain_ironic_config('database/idle_timeout').with_value(params[:database_idle_timeout]) + is_expected.to contain_ironic_config('database/connection_recycle_time').with_value(params[:database_idle_timeout]) is_expected.to contain_ironic_config('database/retry_interval').with_value(params[:database_retry_interval]) end diff --git a/spec/classes/ironic_inspector_db_spec.rb b/spec/classes/ironic_inspector_db_spec.rb index 83a3d8b7..5072e6b4 100644 --- a/spec/classes/ironic_inspector_db_spec.rb +++ b/spec/classes/ironic_inspector_db_spec.rb @@ -6,42 +6,42 @@ describe 'ironic::inspector::db' do context 'with default parameters' do it { should contain_oslo__db('ironic_inspector_config').with( - :connection => 'sqlite:////var/lib/ironic-inspector/inspector.sqlite', - :idle_timeout => '', - :min_pool_size => '', - :max_pool_size => '', - :max_retries => '', - :db_max_retries => '', - :pool_timeout => '', - :retry_interval => '', - :max_overflow => '', + :connection => 'sqlite:////var/lib/ironic-inspector/inspector.sqlite', + :connection_recycle_time => '', + :min_pool_size => '', + :max_pool_size => '', + :max_retries => '', + :db_max_retries => '', + :pool_timeout => '', + :retry_interval => '', + :max_overflow => '', )} end context 'with specific parameters' do let :params do - { :database_connection => 'mysql+pymysql://ironic:ironic@localhost/ironic', - :database_idle_timeout => '3601', - :database_min_pool_size => '2', - :database_max_pool_size => '21', - :database_max_retries => '11', - :database_db_max_retries => '11', - :database_max_overflow => '21', - :database_pool_timeout => '21', - :database_retry_interval => '11', } + { :database_connection => 'mysql+pymysql://ironic:ironic@localhost/ironic', + :database_connection_recycle_time => '3601', + :database_min_pool_size => '2', + :database_max_pool_size => '21', + :database_max_retries => '11', + :database_db_max_retries => '11', + :database_max_overflow => '21', + :database_pool_timeout => '21', + :database_retry_interval => '11', } end it { should contain_oslo__db('ironic_inspector_config').with( - :connection => 'mysql+pymysql://ironic:ironic@localhost/ironic', - :idle_timeout => '3601', - :min_pool_size => '2', - :max_pool_size => '21', - :max_retries => '11', - :db_max_retries => '11', - :pool_timeout => '21', - :retry_interval => '11', - :max_overflow => '21', + :connection => 'mysql+pymysql://ironic:ironic@localhost/ironic', + :connection_recycle_time => '3601', + :min_pool_size => '2', + :max_pool_size => '21', + :max_retries => '11', + :db_max_retries => '11', + :pool_timeout => '21', + :retry_interval => '11', + :max_overflow => '21', )} end