Deprecate database options from the base class

This patch deprecates database options in the ``ironic`` class and
the ``ironic::inspector`` class, because these options were already
implemented in independent db classes.

Change-Id: I6c676a7b56c6f748430b4e112251279eb618074d
This commit is contained in:
Takashi Kajinami 2020-10-20 11:51:41 +09:00
parent 82a5587266
commit de4f7d5138
3 changed files with 101 additions and 40 deletions

View File

@ -204,34 +204,6 @@
# (Optional) Password for message broker authentication
# Defaults to $::os_service_default.
#
# [*database_connection*]
# (optional) Connection url for the ironic database.
# Defaults to: undef
#
# [*database_max_retries*]
# (optional) Database reconnection retry times.
# Defaults to: undef
#
# [*database_idle_timeout*]
# (optional) Timeout before idle db connections are reaped.
# Defaults to: undef
#
# [*database_reconnect_interval*]
# (optional) Database reconnection interval in seconds.
# Defaults to: undef
#
# [*database_retry_interval*]
# (optional) Database reconnection interval in seconds.
# Defaults to: undef
#
# [*database_max_pool_size*]
# (optional) Maximum number of SQL connections to keep open in a pool.
# Defaults to: undef
#
# [*database_max_overflow*]
# (optional) If set, use this value for max_overflow with sqlalchemy.
# Defaults to: undef
#
# [*sync_db*]
# Enable dbsync
# Defaults to true
@ -274,6 +246,34 @@
# (optional) Minimum number of SQL connections to keep open in a pool.
# Defaults to: undef
#
# [*database_connection*]
# (optional) Connection url for the ironic database.
# Defaults to: undef
#
# [*database_max_retries*]
# (optional) Database reconnection retry times.
# Defaults to: undef
#
# [*database_idle_timeout*]
# (optional) Timeout before idle db connections are reaped.
# Defaults to: undef
#
# [*database_reconnect_interval*]
# (optional) Database reconnection interval in seconds.
# Defaults to: undef
#
# [*database_retry_interval*]
# (optional) Database reconnection interval in seconds.
# Defaults to: undef
#
# [*database_max_pool_size*]
# (optional) Maximum number of SQL connections to keep open in a pool.
# Defaults to: undef
#
# [*database_max_overflow*]
# (optional) If set, use this value for max_overflow with sqlalchemy.
# Defaults to: undef
#
class ironic (
$enabled = true,
$package_ensure = 'present',
@ -314,13 +314,6 @@ class ironic (
$amqp_sasl_config_name = $::os_service_default,
$amqp_username = $::os_service_default,
$amqp_password = $::os_service_default,
$database_connection = undef,
$database_max_retries = undef,
$database_idle_timeout = undef,
$database_reconnect_interval = undef,
$database_retry_interval = undef,
$database_max_pool_size = undef,
$database_max_overflow = undef,
$sync_db = true,
$db_online_data_migrations = false,
$purge_config = false,
@ -331,12 +324,55 @@ class ironic (
$versioned_notifications_topics = $::os_service_default,
# DEPRECATED PARAMETERS
$database_min_pool_size = undef,
$database_connection = undef,
$database_max_retries = undef,
$database_idle_timeout = undef,
$database_reconnect_interval = undef,
$database_retry_interval = undef,
$database_max_pool_size = undef,
$database_max_overflow = undef,
) {
include ironic::deps
include ironic::db
include ironic::params
if $database_connection != undef {
warning('The database_connection parameter is deprecated and will be \
removed in a future realse. Use ironic::db::database_connection instead')
}
if $database_max_retries!= undef {
warning('The database_max_retries parameter is deprecated and will be \
removed in a future realse. Use ironic::db::database_max_retries instead')
}
if $database_idle_timeout != undef {
warning('The database_idle_timeout parameter is deprecated and will be \
removed in a future realse. Use ironic::db::database_connection_recycle_time \
instead')
}
if $database_reconnect_interval != undef {
warning('The database_reconnect_interval parameter is deprecated \
has no effect now.')
}
if $database_retry_interval != undef {
warning('The database_retry_interval parameter is deprecated and will be \
removed in a future realse. Use ironic::db::database_retry_interval instead')
}
if $database_max_pool_size != undef {
warning('The database_max_pool_size parameter is deprecated and will be \
removed in a future realse. Use ironic::db::database_max_pool_size instead')
}
if $database_max_overflow != undef {
warning('The database_max_overflow parameter is deprecated and will be \
removed in a future realse. Use ironic::db::database_max_overflow instead')
}
include ironic::glance
include ironic::neutron

View File

@ -52,10 +52,6 @@
# to listen on
# Defaults to 'br-ctlplane'
#
# [*db_connection*]
# (optional) Location of the ironic-inspector node cache database
# Defaults to undef
#
# [*ramdisk_logs_dir*]
# (optional) Location to store logs retrieved from the ramdisk
# Defaults to '/var/log/ironic-inspector/ramdisk/'
@ -256,6 +252,10 @@
# (optional) Interval between retries in case of conflict error
# Defaults to undef.
#
# [*db_connection*]
# (optional) Location of the ironic-inspector node cache database
# Defaults to undef
#
class ironic::inspector (
$package_ensure = 'present',
$enabled = true,
@ -265,7 +265,6 @@ class ironic::inspector (
$auth_strategy = 'keystone',
$timeout = $::os_service_default,
$dnsmasq_interface = 'br-ctlplane',
$db_connection = undef,
$ramdisk_logs_dir = '/var/log/ironic-inspector/ramdisk/',
$always_store_ramdisk_logs = $::os_service_default,
$add_ports = $::os_service_default,
@ -309,6 +308,7 @@ class ironic::inspector (
$ironic_url = undef,
$ironic_max_retries = undef,
$ironic_retry_interval = undef,
$db_connection = undef,
) {
include ironic::deps
@ -318,6 +318,11 @@ class ironic::inspector (
include ironic::inspector::swift
include ironic::inspector::ironic
if $db_connection != undef {
warning('The db_connection parameter is deprecated and will be removed \
in a future realse. Use ironic::inspector::db::database_connection instead')
}
if $ironic_url != undef {
warn('ironic::inspector::ironic_url is now deprecated and has no effect. \
Use ironic::inspector::ironic::endpoint_override instead.')

View File

@ -0,0 +1,20 @@
---
deprecations:
- |
The following options have been deprecated, as those options have been
moved to ironic::db class.
- ``ironic::database_connection``
- ``ironic::database_idle_timeout``
- ``ironic::database_max_overflow``
- ``ironic::database_max_pool_size``
- ``ironic::database_max_retries``
- ``ironic::database_retry_interval``
- |
The ``ironic::database_reconnect_interval`` parameter has been deprecated
and now has no effect.
- |
The ``ironic::inspector::db_connection`` parameter has been deprecated. Use
the ``ironic::inspector::db::database_connection`` parameter instead.