diff --git a/manifests/db.pp b/manifests/db.pp index 7713e07d..fbd22b34 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/heat/heat.sqlite'. # -# [*database_idle_timeout*] +# [*database_connection_recycle_time*] # Timeout when db connections should be reaped. # (Optional) Defaults to $::os_service_default. # @@ -46,25 +46,39 @@ # (Optional) Run db sync on nodes after connection setting has been set. # Defaults to true # +# DEPRECATED PARAMETERS +# +# [*database_idle_timeout*] +# Timeout when db connections should be reaped. +# Defaults to undef. +# + class heat::db ( - $database_connection = 'sqlite:////var/lib/heat/heat.sqlite', - $database_idle_timeout = $::os_service_default, - $database_min_pool_size = $::os_service_default, - $database_max_pool_size = $::os_service_default, - $database_max_retries = $::os_service_default, - $database_retry_interval = $::os_service_default, - $database_max_overflow = $::os_service_default, - $database_pool_timeout = $::os_service_default, - $database_db_max_retries = $::os_service_default, - $sync_db = true, + $database_connection = 'sqlite:////var/lib/heat/heat.sqlite', + $database_connection_recycle_time = $::os_service_default, + $database_min_pool_size = $::os_service_default, + $database_max_pool_size = $::os_service_default, + $database_max_retries = $::os_service_default, + $database_retry_interval = $::os_service_default, + $database_max_overflow = $::os_service_default, + $database_pool_timeout = $::os_service_default, + $database_db_max_retries = $::os_service_default, + $sync_db = true, + # DEPRECATED PARAMETERS + $database_idle_timeout = undef, ) { include ::heat::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 heat:: if heat::db:: isn't specified. $database_connection_real = pick($::heat::database_connection, $database_connection) - $database_idle_timeout_real = pick($::heat::database_idle_timeout, $database_idle_timeout) + $database_connection_recycle_time_real = pick($::heat::database_idle_timeout, $database_idle_timeout, $database_connection_recycle_time) $database_min_pool_size_real = pick($::heat::database_min_pool_size, $database_min_pool_size) $database_max_pool_size_real = pick($::heat::database_max_pool_size, $database_max_pool_size) $database_max_retries_real = pick($::heat::database_max_retries, $database_max_retries) @@ -76,15 +90,15 @@ class heat::db ( ['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?']) oslo::db { 'heat_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, - pool_timeout => $database_pool_timeout, - db_max_retries => $database_db_max_retries, + 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, + pool_timeout => $database_pool_timeout, + db_max_retries => $database_db_max_retries, } if $sync_db_real { diff --git a/releasenotes/notes/deprecate_idle_timeout_parameter-9634c25458cd349b.yaml b/releasenotes/notes/deprecate_idle_timeout_parameter-9634c25458cd349b.yaml new file mode 100644 index 00000000..09e76c41 --- /dev/null +++ b/releasenotes/notes/deprecate_idle_timeout_parameter-9634c25458cd349b.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/heat_db_spec.rb b/spec/classes/heat_db_spec.rb index eb62aebf..4fa17348 100644 --- a/spec/classes/heat_db_spec.rb +++ b/spec/classes/heat_db_spec.rb @@ -6,15 +6,15 @@ describe 'heat::db' do it { should contain_class('heat::deps') } it { should contain_oslo__db('heat_config').with( - :db_max_retries => '', - :connection => 'sqlite:////var/lib/heat/heat.sqlite', - :idle_timeout => '', - :min_pool_size => '', - :max_pool_size => '', - :max_retries => '', - :retry_interval => '', - :max_overflow => '', - :pool_timeout => '', + :db_max_retries => '', + :connection => 'sqlite:////var/lib/heat/heat.sqlite', + :connection_recycle_time => '', + :min_pool_size => '', + :max_pool_size => '', + :max_retries => '', + :retry_interval => '', + :max_overflow => '', + :pool_timeout => '', )} it { should contain_class('heat::db::sync') } @@ -23,31 +23,31 @@ describe 'heat::db' do context 'with specific parameters' do let :params do { - :database_connection => 'mysql+pymysql://heat:heat@localhost/heat', - :database_idle_timeout => '3601', - :database_min_pool_size => '2', - :database_max_pool_size => '12', - :database_max_retries => '11', - :database_retry_interval => '11', - :database_db_max_retries => '-1', - :database_max_overflow => '21', - :database_pool_timeout => '21', - :sync_db => false + :database_connection => 'mysql+pymysql://heat:heat@localhost/heat', + :database_connection_recycle_time => '3601', + :database_min_pool_size => '2', + :database_max_pool_size => '12', + :database_max_retries => '11', + :database_retry_interval => '11', + :database_db_max_retries => '-1', + :database_max_overflow => '21', + :database_pool_timeout => '21', + :sync_db => false } end it { should contain_class('heat::deps') } it { should contain_oslo__db('heat_config').with( - :db_max_retries => '-1', - :connection => 'mysql+pymysql://heat:heat@localhost/heat', - :idle_timeout => '3601', - :min_pool_size => '2', - :max_pool_size => '12', - :max_retries => '11', - :retry_interval => '11', - :max_overflow => '21', - :pool_timeout => '21', + :db_max_retries => '-1', + :connection => 'mysql+pymysql://heat:heat@localhost/heat', + :connection_recycle_time => '3601', + :min_pool_size => '2', + :max_pool_size => '12', + :max_retries => '11', + :retry_interval => '11', + :max_overflow => '21', + :pool_timeout => '21', )} it { should_not contain_class('heat::db::sync') }