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: Ieb3480254411f1251df7bbcdc85b3952b46f3335

manifests/api/logging.pp

@@ -38,10 +38,6 @@
 #   If set to $facts['os_service_default'], it will not log to any file.
 #   Defaults to '/var/log/glance/api.log'.
 #
-# [*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'].
@@ -102,6 +98,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 glance::api::logging(
   $use_syslog                    = $facts['os_service_default'],
   $use_json                      = $facts['os_service_default'],
@@ -110,7 +112,6 @@ class glance::api::logging(
   $log_facility                  = $facts['os_service_default'],
   $log_dir                       = '/var/log/glance',
   $log_file                      = '/var/log/glance/api.log',
-  $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'],
@@ -123,6 +124,8 @@ class glance::api::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 glance::deps

manifests/cache/logging.pp

@@ -33,10 +33,6 @@
 #    (optional) File where logs should be stored.
 #    Defaults to '/var/log/glance/cache.log'
 #
-# [*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 glance::cache::logging(
   $use_syslog                    = $facts['os_service_default'],
   $use_json                      = $facts['os_service_default'],
@@ -104,7 +106,6 @@ class glance::cache::logging(
   $log_facility                  = $facts['os_service_default'],
   $log_dir                       = '/var/log/glance',
   $log_file                      = '/var/log/glance/cache.log',
-  $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 glance::cache::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 glance::deps

releasenotes/notes/deprecate-watch_log_file-5345fe2410b870f3.yaml

@@ -0,0 +1,8 @@
+---
+deprecations:
+  - |
+    The ``glance::api::logging::watch_log_file`` parameter has been deprecated.
+
+  - |
+    The ``glance::cache::logging::watch_log_file`` parameter has been
+    deprecated.

spec/classes/glance_api_logging_spec.rb

@@ -66,7 +66,6 @@ describe 'glance::api::logging' do
         :use_stderr     => '<SERVICE DEFAULT>',
         :log_dir        => '/var/log/glance',
         :log_file       => '/var/log/glance/api.log',
-        :watch_log_file => '<SERVICE DEFAULT>',
         :debug          => '<SERVICE DEFAULT>',
       )
     end

spec/classes/glance_cache_logging_spec.rb

@@ -64,7 +64,6 @@ describe 'glance::cache::logging' do
         :use_stderr     => '<SERVICE DEFAULT>',
         :log_dir        => '/var/log/glance',
         :log_file       => '/var/log/glance/cache.log',
-        :watch_log_file => '<SERVICE DEFAULT>',
         :debug          => '<SERVICE DEFAULT>',
       )
     end