ironic.conductor.cleaning module¶
Functionality related to cleaning.
- ironic.conductor.cleaning.continue_node_clean(task)[source]¶
Continue cleaning after finishing an async clean step.
This function calculates which step has to run next and passes control into do_next_clean_step.
- Parameters:
task – a TaskManager instance with an exclusive lock
- ironic.conductor.cleaning.do_next_clean_step(task, step_index, disable_ramdisk=None)[source]¶
Do cleaning, starting from the specified clean step.
- Parameters:
task – a TaskManager instance with an exclusive lock
step_index – The first clean step in the list to execute. This is the index (from 0) into the list of clean steps in the node’s driver_internal_info[‘clean_steps’]. Is None if there are no steps to execute.
disable_ramdisk – Whether to skip booting ramdisk for cleaning.
- ironic.conductor.cleaning.do_node_clean(task, clean_steps=None, disable_ramdisk=False, automated_with_steps=False)[source]¶
Internal RPC method to perform cleaning of a node.
- Parameters:
task – a TaskManager instance with an exclusive lock on its node
clean_steps – For a manual clean, the list of clean steps to perform. Is None For automated cleaning (default). For more information, see the clean_steps parameter of
ConductorManager.do_node_clean().disable_ramdisk – Whether to skip booting ramdisk for cleaning.
automated_with_steps – Indicates this is a declarative automated clean powered by a runbook.
- ironic.conductor.cleaning.do_node_clean_abort(task)[source]¶
Internal method to abort an ongoing operation.
- Parameters:
task – a TaskManager instance with an exclusive lock
- ironic.conductor.cleaning.execute_step_on_child_nodes(task, step)[source]¶
Execute a requested step against a child node.
- Parameters:
task – The TaskManager object for the parent node.
step – The requested step to be executed.
- Returns:
None on Success, the resulting error message if a failure has occurred.
