The ironic.drivers.modules.agent Module

class ironic.drivers.modules.agent.AgentDeploy

Bases: ironic.drivers.base.DeployInterface

Interface for deploy-related actions.

clean_up(task)

Clean up the deployment environment for this node.

If preparation of the deployment environment ahead of time is possible, this method should be implemented by the driver. It should erase anything cached by the prepare method.

If implemented, this method must be idempotent. It may be called multiple times for the same node on the same conductor, and it may be called by multiple conductors in parallel. Therefore, it must not require an exclusive lock.

This method is called before tear_down.

Parameters:task – a TaskManager instance.

deploy(*args, **kwargs)

Perform a deployment to a node.

Perform the necessary work to deploy an image onto the specified node. This method will be called after prepare(), which may have already performed any preparatory steps, such as pre-caching some data for the node.

Parameters:task – a TaskManager instance. Returns:status of the deploy. One of ironic.common.states.

execute_clean_step(task, step)

Execute a clean step asynchronously on the agent.

Parameters:

• task – a TaskManager object containing the node
• step – a clean step dictionary to execute

Raises:

NodeCleaningFailure if the agent does not return a command status

Returns:

states.CLEANING to signify the step will be completed async

get_clean_steps(task)

Get the list of clean steps from the agent.

Parameters:task – a TaskManager object containing the node Returns:A list of clean step dictionaries

get_properties()

Return the properties of the interface.

Returns:dictionary of <property name>:<property description> entries.

prepare(task)

Prepare the deployment environment for this node.

Parameters:task – a TaskManager instance.

prepare_cleaning(task)

Boot into the agent to prepare for cleaning.

Parameters:task – a TaskManager object containing the node Raises NodeCleaningFailure:  if the previous cleaning ports cannot be removed or if new cleaning ports cannot be created Returns:states.CLEANING to signify an asynchronous prepare

take_over(task)

Take over management of this node from a dead conductor.

If conductors’ hosts maintain a static relationship to nodes, this method should be implemented by the driver to allow conductors to perform the necessary work during the remapping of nodes to conductors when a conductor joins or leaves the cluster.

For example, the PXE driver has an external dependency:

Neutron must forward DHCP BOOT requests to a conductor which has prepared the tftpboot environment for the given node. When a conductor goes offline, another conductor must change this setting in Neutron as part of remapping that node’s control to itself. This is performed within the takeover method.

Parameters:task – a TaskManager instance.

tear_down(*args, **kwargs)

Tear down a previous deployment on the task’s node.

Parameters:task – a TaskManager instance. Returns:status of the deploy. One of ironic.common.states.

tear_down_cleaning(task)

Clean up the PXE and DHCP files after cleaning.

Parameters:task – a TaskManager object containing the node Raises NodeCleaningFailure:  if the cleaning ports cannot be removed

validate(task)

Validate the driver-specific Node deployment info.

This method validates whether the properties of the supplied node contain the required information for this driver to deploy images to the node.

Parameters:task – a TaskManager instance Raises:MissingParameterValue

class ironic.drivers.modules.agent.AgentTFTPImageCache(image_service=None)

Bases: ironic.drivers.modules.image_cache.ImageCache

class ironic.drivers.modules.agent.AgentVendorInterface

Bases: ironic.drivers.modules.agent_base_vendor.BaseAgentVendor

check_deploy_success(node)

continue_deploy(*args, **kwargs)

deploy_is_done(task)

reboot_to_instance(task, **kwargs)