Deprecated log_bmc_address option

We already have too many options to my taste, and this does not seem too useful:
we anyway don't log BMC address if it's empty.

I think we should provide consistent logging experience.

Change-Id: I8ae8856bdc1ff26065c626837df9edc3016737e4

devstack/plugin.sh

@@ -204,7 +204,6 @@ function configure_inspector {
     mkdir_chown_stack "$IRONIC_INSPECTOR_RAMDISK_LOGDIR"
     inspector_iniset processing ramdisk_logs_dir "$IRONIC_INSPECTOR_RAMDISK_LOGDIR"
     inspector_iniset processing always_store_ramdisk_logs "$IRONIC_INSPECTOR_ALWAYS_STORE_RAMDISK_LOGS"
-    inspector_iniset processing log_bmc_address False
     if [ -n "$IRONIC_INSPECTOR_NODE_NOT_FOUND_HOOK" ]; then
         inspector_iniset processing node_not_found_hook "$IRONIC_INSPECTOR_NODE_NOT_FOUND_HOOK"
     fi

example.conf

@@ -844,8 +844,10 @@
 # local_gb is calculated on the ramdisk side. (boolean value)
 #disk_partitioning_spacing = true
 
-# Whether to log node BMC address with every message during
-# processing. (boolean value)
+# DEPRECATED: Whether to log node BMC address with every message
+# during processing. (boolean value)
+# This option is deprecated for removal.
+# Its value may be silently ignored in the future.
 #log_bmc_address = true
 
 # File name template for storing ramdisk logs. The following

ironic_inspector/conf.py

@@ -128,7 +128,8 @@ PROCESSING_OPTS = [
     cfg.BoolOpt('log_bmc_address',
                 default=True,
                 help=_('Whether to log node BMC address with every message '
-                       'during processing.')),
+                       'during processing.'),
+                deprecated_for_removal=True),
     cfg.StrOpt('ramdisk_logs_filename_format',
                default='{uuid}_{dt:%Y%m%d-%H%M%S.%f}.tar.gz',
                help=_('File name template for storing ramdisk logs. The '

releasenotes/notes/bmc-logging-deprecation-4ca046a64fac6f11.yaml

@@ -0,0 +1,4 @@
+---
+deprecations:
+  - |
+    The configuration option "log_bmc_address" is deprecated.