Deprecate [ilo]/clean_priority_erase_devices config

The [ilo]/clean_priority_erase_devices configuration option is
duplicated by [deploy]/erase_devices_priority, this patch is marking the
ilo configuration as deprecated.

The ironic.conf.sample was also updated to reflect the changes.

Closes-Bug: #1515871
Change-Id: I2bf18e35d97160d31a51c8447745bfd60c099af2

etc/ironic/ironic.conf.sample

@@ -920,17 +920,18 @@
 
 # Size of EFI system partition in MiB when configuring UEFI
 # systems for local boot. (integer value)
-# Deprecated group/name - [deploy]/efi_system_partition_size
 #efi_system_partition_size = 200
 
+# Size of BIOS Boot partition in MiB when configuring GPT
+# partitioned systems for local boot in BIOS. (integer value)
+#bios_boot_partition_size = 1
+
 # Block size to use when writing to the nodes disk. (string
 # value)
-# Deprecated group/name - [deploy]/dd_block_size
 #dd_block_size = 1M
 
 # Maximum attempts to verify an iSCSI connection is active,
 # sleeping 1 second between attempts. (integer value)
-# Deprecated group/name - [deploy]/iscsi_verify_attempts
 #iscsi_verify_attempts = 3
 
 
@@ -1108,9 +1109,13 @@
 # (boolean value)
 #use_web_server_for_images = false
 
-# Priority for erase devices clean step. If unset, it defaults
+# DEPRECATED: Priority for erase devices clean step. If unset,
-# to 10. If set to 0, the step will be disabled and will not
+# it defaults to 10. If set to 0, the step will be disabled
-# run during cleaning. (integer value)
+# and will not run during cleaning. (integer value)
+# This option is deprecated for removal.
+# Its value may be silently ignored in the future.
+# Reason: This configuration option is duplicated by [deploy]
+# erase_devices_priority, please use that instead.
 #clean_priority_erase_devices = <None>
 
 # Priority for reset_ilo clean step. (integer value)
@@ -1289,7 +1294,16 @@
 # From keystonemiddleware.auth_token
 #
 
-# Complete public Identity API endpoint. (string value)
+# Complete "public" Identity API endpoint. This endpoint
+# should not be an "admin" endpoint, as it should be
+# accessible by all end users. Unauthenticated clients are
+# redirected to this endpoint to authenticate. Although this
+# endpoint should  ideally be unversioned, client support in
+# the wild varies.  If you're using a versioned v2 endpoint
+# here, then this  should *not* be the same endpoint the
+# service user utilizes  for validating tokens, because normal
+# end users may not be  able to reach that endpoint. (string
+# value)
 #auth_uri = <None>
 
 # API version of the admin Identity API endpoint. (string
@@ -1428,12 +1442,12 @@
 # (list value)
 #hash_algorithms = md5
 
-# Authentication type to load (unknown value)
+# Authentication type to load (string value)
 # Deprecated group/name - [keystone_authtoken]/auth_plugin
 #auth_type = <None>
 
 # Config Section from which to load plugin specific options
-# (unknown value)
+# (string value)
 #auth_section = <None>
 
 

ironic/conf/ilo.py

@@ -41,6 +41,10 @@ opts = [
                        'to host the floppy images and generated '
                        'boot_iso.')),
     cfg.IntOpt('clean_priority_erase_devices',
+               deprecated_for_removal=True,
+               deprecated_reason=_('This configuration option is duplicated '
+                                   'by [deploy] erase_devices_priority, '
+                                   'please use that instead.'),
                help=_('Priority for erase devices clean step. If unset, '
                       'it defaults to 10. If set to 0, the step will be '
                       'disabled and will not run during cleaning.')),

ironic/drivers/modules/ilo/deploy.py

@@ -293,12 +293,12 @@ class IloVirtualMediaAgentDeploy(agent.AgentDeploy):
         :returns: A list of clean step dictionaries
         """
 
-        # TODO(stendulker): All drivers use CONF.deploy.erase_devices_priority
+        priority = CONF.ilo.clean_priority_erase_devices
-        # agent_ilo driver should also use the same. Defect has been filed for
+        if priority is None:
-        # the same.
+            priority = CONF.deploy.erase_devices_priority
-        # https://bugs.launchpad.net/ironic/+bug/1515871
+
         new_priorities = {
-            'erase_devices': CONF.ilo.clean_priority_erase_devices,
+            'erase_devices': priority,
         }
         return deploy_utils.agent_get_clean_steps(
             task, interface='deploy',

releasenotes/notes/ilo-erase-device-priority-config-509661955a11c28e.yaml

@@ -0,0 +1,5 @@
+---
+deprecations:
+  - The [ilo]/clean_priority_erase_devices config is deprecated and will be
+    removed in the Ocata cycle. Please use the [deploy]/erase_devices_priority
+    config instead.