openstack/puppet-ironic
Code Issues Proposed changes

Merge "logging: Deprecate watch_log_file"

Browse Source
This commit is contained in:
Zuul 2024-09-24 02:15:12 +00:00 committed by Gerrit Code Review
commit efd8bcdbdb
5 changed files with 24 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
manifests/inspector/logging.pp
View File

@ -33,10 +33,6 @@
# (Optional) File where logs should be stored.
# Defaults to $facts['os_service_default']
#
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to $facts['os_service_default']
#
# [*logging_context_format_string*]
# (optional) Format string to use for log messages with context.
# Defaults to $facts['os_service_default']
@ -97,6 +93,12 @@
# Defaults to $facts['os_service_default']
# Example: 'Y-%m-%d %H:%M:%S'
#
# DEPRECATED PARAMETERS
#
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to undef
#
class ironic::inspector::logging(
$use_syslog = $facts['os_service_default'],
$use_json = $facts['os_service_default'],
@ -104,7 +106,6 @@ class ironic::inspector::logging(
$log_facility = $facts['os_service_default'],
$log_dir = '/var/log/ironic-inspector',
$log_file = $facts['os_service_default'],
$watch_log_file = $facts['os_service_default'],
$debug = $facts['os_service_default'],
$logging_context_format_string = $facts['os_service_default'],
$logging_default_format_string = $facts['os_service_default'],
@ -117,6 +118,8 @@ class ironic::inspector::logging(
$instance_format = $facts['os_service_default'],
$instance_uuid_format = $facts['os_service_default'],
$log_date_format = $facts['os_service_default'],
# DEPRECATED PARAMETERS
$watch_log_file = undef,
) {
include ironic::deps

13
manifests/logging.pp
View File

@ -37,10 +37,6 @@
# (Optional) File where logs should be stored.
# Defaults to $facts['os_service_default']
#
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to $facts['os_service_default']
#
# [*logging_context_format_string*]
# (Optional) Format string to use for log messages with context.
# Defaults to $facts['os_service_default']
@ -101,6 +97,12 @@
# Defaults to $facts['os_service_default']
# Example: 'Y-%m-%d %H:%M:%S'
#
# DEPRECATED PARAMETERS
#
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to undef
#
class ironic::logging(
$use_syslog = $facts['os_service_default'],
$use_json = $facts['os_service_default'],
@ -109,7 +111,6 @@ class ironic::logging(
$log_facility = $facts['os_service_default'],
$log_dir = '/var/log/ironic',
$log_file = $facts['os_service_default'],
$watch_log_file = $facts['os_service_default'],
$debug = $facts['os_service_default'],
$logging_context_format_string = $facts['os_service_default'],
$logging_default_format_string = $facts['os_service_default'],
@ -122,6 +123,8 @@ class ironic::logging(
$instance_format = $facts['os_service_default'],
$instance_uuid_format = $facts['os_service_default'],
$log_date_format = $facts['os_service_default'],
# DEPRECATED PARAMETERS
$watch_log_file = undef,
) {
include ironic::deps

8
releasenotes/notes/deprecate-watch_log_file-7cef8a3b7a8d18db.yaml Normal file
View File

@ -0,0 +1,8 @@
---
deprecations:
- |
The ``ironic::logging::watch_log_file`` parameter has been deprecated.
- |
The ``ironic::inspector::logging::watch_log_file`` parameter has been
deprecated.

1
spec/classes/ironic_inspector_logging_spec.rb
View File

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

1
spec/classes/ironic_logging_spec.rb
View File

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