ironic.conductor.steps module

ironic.conductor.steps.find_step(steps, step)

Find an identical step in the list of steps.

ironic.conductor.steps.is_equivalent(step1, step2)

Compare steps, ignoring their priority.

ironic.conductor.steps.set_node_cleaning_steps(task, disable_ramdisk=False, use_existing_steps=False)

Set up the node with clean step information for cleaning.

For automated cleaning, get the clean steps from the driver. For manual cleaning, the user’s clean steps are known but need to be validated against the driver’s clean steps.

Parameters:

• task – A TaskManager object

• disable_ramdisk – If True, only steps with requires_ramdisk=False are accepted.

• use_existing_steps – If True, validate existing steps from driver_internal_info[‘clean_steps’] which comes from manual cleaning API call or a runbook-based declarative automated cleaning. If False, retrieve cleaning steps from the driver (implicit automated cleaning).

Raises:

InvalidParameterValue if there is a problem with the user’s clean steps.

Raises:

NodeCleaningFailure if there was a problem getting the clean steps.

ironic.conductor.steps.set_node_deployment_steps(task, reset_current=True, skip_missing=False)

Set up the node with deployment step information for deploying.

Get the deploy steps from the driver.

Parameters:

reset_current – Whether to reset the current step to the first one.

Raises:

InstanceDeployFailure if there was a problem getting the deployment steps.

ironic.conductor.steps.set_node_service_steps(task, disable_ramdisk=False)

Set up the node with clean step information for cleaning.

For automated cleaning, get the clean steps from the driver. For manual cleaning, the user’s clean steps are known but need to be validated against the driver’s clean steps.

Parameters:

disable_ramdisk – If True, only steps with requires_ramdisk=False are accepted.

Raises:

InvalidParameterValue if there is a problem with the user’s clean steps.

Raises:

NodeServicingFailure if there was a problem getting the service steps.

ironic.conductor.steps.step_id(step)

Return the ‘ID’ of a deploy step.

The ID is a string, <interface>.<step>.

Parameters:

step – the step dictionary.

Returns:

the step’s ID string.

ironic.conductor.steps.use_reserved_step_handler(task, step)

Returns guidance for reserved step execution or process is used.

This method is utilized to handle some specific cases with the execution of steps. For example, reserved step names, or reserved names which have specific meaning in the state machine.

Parameters:

• task – a TaskManager object.

• step – The requested step.

ironic.conductor.steps.validate_user_deploy_steps_and_templates(task, deploy_steps=None, skip_missing=False)

Validate the user deploy steps and the deploy templates for a node.

Parameters:

• task – A TaskManager object

• deploy_steps – Deploy steps to validate. Optional. If not provided then will check node’s driver internal info.

• skip_missing – whether skip missing steps that are not yet available at the time of validation.

Raises:

InvalidParameterValue if the instance has traits that map to deploy steps that are unsupported by the node’s driver interfaces or user deploy steps are unsupported by the node’s driver interfaces

Raises:

InstanceDeployFailure if there was a problem getting the deploy steps from the driver.