logging: Deprecate watch_log_file

This option was deprecated in oslo.log 6.0.0 [1]. Because the warning
to catch usage of the parameter is implemented in the underlying
oslo::log defined resource type, no additional warning message is
implemented in this module.

[1] https://review.opendev.org/914788

Depends-on: https://review.opendev.org/930126
Change-Id: I2d010ba17d448da5eedf18417b88897248b7ddce
This commit is contained in:
Takashi Kajinami 2024-09-22 02:05:09 +09:00
parent f3e88e7091
commit fac33e4525
3 changed files with 12 additions and 6 deletions

View File

@ -43,10 +43,6 @@
# Defaults to $facts['os_service_default']
# Example: 'Y-%m-%d %H:%M:%S'
#
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to $facts['os_service_default']
#
# [*syslog_log_facility*]
# (Optional) Syslog facility to receive log lines.
# This option is ignored if log_config_append is set.
@ -105,6 +101,12 @@
# (Optional) Enables or disables fatal status of deprecations (boolean value).
# Defaults to $facts['os_service_default']
#
# DEPRECATED PARAMETERS
#
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to undef
#
class neutron::logging (
$debug = $facts['os_service_default'],
$use_syslog = $facts['os_service_default'],
@ -115,7 +117,6 @@ class neutron::logging (
$log_dir = '/var/log/neutron',
$log_config_append = $facts['os_service_default'],
$log_date_format = $facts['os_service_default'],
$watch_log_file = $facts['os_service_default'],
$syslog_log_facility = $facts['os_service_default'],
$logging_context_format_string = $facts['os_service_default'],
$logging_default_format_string = $facts['os_service_default'],
@ -127,6 +128,8 @@ class neutron::logging (
$instance_format = $facts['os_service_default'],
$instance_uuid_format = $facts['os_service_default'],
$fatal_deprecations = $facts['os_service_default'],
# DEPRECATED PARAMETERS
$watch_log_file = undef,
) {
include neutron::deps

View File

@ -0,0 +1,4 @@
---
deprecations:
- |
The ``neutron::logging::watch_log_file`` parameter has been deprecated.

View File

@ -62,7 +62,6 @@ describe 'neutron::logging' do
:syslog_log_facility => '<SERVICE DEFAULT>',
:log_dir => '/var/log/neutron',
:log_file => '<SERVICE DEFAULT>',
:watch_log_file => '<SERVICE DEFAULT>',
:debug => '<SERVICE DEFAULT>',
)
end