Enable automatic node cleaning (#2019)

The goal is to automatically clean nodes on undeployment. This can be
done by ironic through automated cleaning. Unfortunately this will also
enable cleaning when a node transitions from `managable` to `available`.
This would block `osism sync ironic`, since it waits sequentially for
every node to reach the `available` state.
An alternative is to add an explicit clean step in python-osism. However
the `osism manage baremetal undeploy` command is currently a oneshot
request to ironic. Adding a cleaning step would require turning it inot
an asynchronous task.
The taken path is to enable automated cleaning explicitly on a per node
basis once it reaches the `available` state. Care has to be taken to
unset it before transitioning to `available`, since ironic sometimes
moves nodes to `manageable` when errors are encountered.

Depends-On: osism/metalbox#292

Signed-off-by: Jan Horstmann <horstmann@osism.tech>

Author: janhorstmann

osism/tasks/conductor/ironic.py

@@ -263,6 +263,11 @@ def sync_ironic(request_id, get_ironic_parameters, node_name=None, force=False):
                     osism_utils.push_task_output(
                         request_id, f"Creating baremetal node for {device.name}\n"
                     )
+                    # NOTE: Create node without automated_clean, so it can be
+                    # transitioned fast from managable to available later. It
+                    # is also safer to not clean during sync, so that nodes may
+                    # later be adopted with their provisioned data.
+                    node_attributes.update(dict(automated_clean=False))
                     node = openstack.baremetal_node_create(device.name, node_attributes)
                 else:
                     # NOTE: Check whether the baremetal node needs to be updated
@@ -345,6 +350,11 @@ def sync_ironic(request_id, get_ironic_parameters, node_name=None, force=False):
                                 request_id,
                                 f"Transitioning baremetal node to available state for {device.name}\n",
                             )
+                            if node["automated_clean"]:
+                                # NOTE: Skip automated cleaning on transition from managable to available. We are waiting for the transition and do not want to wait on cleaning at this point
+                                node = openstack.baremetal_node_update(
+                                    node["uuid"], dict(automated_clean=False)
+                                )
                             node = openstack.baremetal_node_set_provision_state(
                                 node["uuid"], "provide"
                             )
@@ -353,6 +363,11 @@ def sync_ironic(request_id, get_ironic_parameters, node_name=None, force=False):
                                     node["uuid"], "available"
                                 )
                             )
+                            if not node["automated_clean"]:
+                                # NOTE: Activate automated cleaning, so that future actions will trigger it
+                                node = openstack.baremetal_node_update(
+                                    node["uuid"], dict(automated_clean=True)
+                                )
                             osism_utils.push_task_output(
                                 request_id,
                                 f"Baremetal node for {device.name} is available\n",
@@ -380,6 +395,11 @@ def sync_ironic(request_id, get_ironic_parameters, node_name=None, force=False):
                                 request_id,
                                 f"Baremetal node for {device.name} is manageable\n",
                             )
+                            if node["automated_clean"]:
+                                # NOTE: Skip automated cleaning, we do not want to accidentaly clean at this point
+                                node = openstack.baremetal_node_update(
+                                    node["uuid"], dict(automated_clean=False)
+                                )
                 else:
                     osism_utils.push_task_output(
                         request_id,