The ironic.drivers.base Module

The ironic.drivers.base Module

Abstract base classes for drivers.

ironic.drivers.base.ALL_INTERFACES = set(['management', 'console', 'network', 'power', 'deploy', 'storage', 'inspect', 'boot', 'vendor', 'raid', 'rescue'])

Constant holding all known interfaces.

Includes interfaces not exposed via BaseDriver.all_interfaces.

class ironic.drivers.base.BareDriver[source]

Bases: ironic.drivers.base.BaseDriver

A bare driver object which will have interfaces attached later.

Any composable interfaces should be added as class attributes of this class, as well as appended to core_interfaces or standard_interfaces here.

class ironic.drivers.base.BaseDriver[source]

Bases: object

Base class for all drivers.

Defines the core, standardized, and vendor-specific interfaces for drivers. Any loadable driver must implement all core interfaces. Actual implementation may instantiate one or more classes, as long as the interfaces are appropriate.

get_properties()[source]

Get the properties of the driver.

Returns:dictionary of <property name>:<property description> entries.
classmethod to_hardware_type()[source]

Return corresponding hardware type and hardware interfaces.

Returns:a tuple with two items:
  • new driver field - the target hardware type
  • dictionary containing interfaces to update, e.g. {‘deploy’: ‘iscsi’, ‘power’: ‘ipmitool’}
class ironic.drivers.base.BaseInterface[source]

Bases: object

A base interface implementing common functions for Driver Interfaces.

execute_clean_step(task, step)[source]

Execute the clean step on task.node.

A clean step must take a single positional argument: a TaskManager object. It may take one or more keyword variable arguments (for use with manual cleaning only.)

A step can be executed synchronously or asynchronously. A step should return None if the method has completed synchronously or states.CLEANWAIT if the step will continue to execute asynchronously. If the step executes asynchronously, it should issue a call to the ‘continue_node_clean’ RPC, so the conductor can begin the next clean step.

Parameters:
  • task – A TaskManager object
  • step – The clean step dictionary representing the step to execute
Returns:

None if this method has completed synchronously, or states.CLEANWAIT if the step will continue to execute asynchronously.

get_clean_steps(task)[source]

Get a list of (enabled and disabled) clean steps for the interface.

This function will return all clean steps (both enabled and disabled) for the interface, in an unordered list.

Parameters:task – A TaskManager object, useful for interfaces overriding this function
Raises:NodeCleaningFailure – if there is a problem getting the steps from the driver. For example, when a node (using an agent driver) has just been enrolled and the agent isn’t alive yet to be queried for the available clean steps.
Returns:A list of clean step dictionaries
get_properties()[source]

Return the properties of the interface.

Returns:dictionary of <property name>:<property description> entries.
validate(task)[source]

Validate the driver-specific Node deployment info.

This method validates whether the ‘driver_info’ and/or ‘instance_info’ properties of the task’s node contains the required information for this interface to function.

This method is often executed synchronously in API requests, so it should not conduct long-running checks.

Parameters:task – a TaskManager instance containing the node to act on.
Raises:InvalidParameterValue on malformed parameter(s)
Raises:MissingParameterValue on missing parameter(s)
class ironic.drivers.base.BootInterface[source]

Bases: ironic.drivers.base.BaseInterface

Interface for boot-related actions.

clean_up_instance(task)[source]

Cleans up the boot of instance.

This method cleans up the environment that was setup for booting the instance.

Parameters:task – a task from TaskManager.
Returns:None
clean_up_ramdisk(task)[source]

Cleans up the boot of ironic ramdisk.

This method cleans up the environment that was setup for booting the deploy or rescue ramdisk.

Parameters:task – a task from TaskManager.
Returns:None
prepare_instance(task)[source]

Prepares the boot of instance.

This method prepares the boot of the instance after reading relevant information from the node’s database.

Parameters:task – a task from TaskManager.
Returns:None
prepare_ramdisk(task, ramdisk_params)[source]

Prepares the boot of Ironic ramdisk.

This method prepares the boot of the deploy or rescue ramdisk after reading relevant information from the node’s database.

Parameters:
  • task – a task from TaskManager.
  • ramdisk_params

    the options to be passed to the ironic ramdisk. Different implementations might want to boot the ramdisk in different ways by passing parameters to them. For example,

    When Agent ramdisk is booted to deploy a node, it takes the parameters ipa-api-url, etc.

    Other implementations can make use of ramdisk_params to pass such information. Different implementations of boot interface will have different ways of passing parameters to the ramdisk.

Returns:

None

class ironic.drivers.base.ConsoleInterface[source]

Bases: ironic.drivers.base.BaseInterface

Interface for console-related actions.

get_console(task)[source]

Get connection information about the console.

This method should return the necessary information for the client to access the console.

Parameters:task – a TaskManager instance containing the node to act on.
Returns:the console connection information.
start_console(task)[source]

Start a remote console for the task’s node.

This method should not raise an exception if console already started.

Parameters:task – a TaskManager instance containing the node to act on.
stop_console(task)[source]

Stop the remote console session for the task’s node.

Parameters:task – a TaskManager instance containing the node to act on.
class ironic.drivers.base.DeployInterface[source]

Bases: ironic.drivers.base.BaseInterface

Interface for deploy-related actions.

clean_up(task)[source]

Clean up the deployment environment for the task’s 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 containing the node to act on.
deploy(task)[source]

Perform a deployment to the task’s 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 containing the node to act on.
Returns:status of the deploy. One of ironic.common.states.
heartbeat(task, callback_url, agent_version)[source]

Record a heartbeat for the node.

Parameters:
  • task – a TaskManager instance containing the node to act on.
  • callback_url – a URL to use to call to the ramdisk.
  • agent_version – The version of the agent that is heartbeating
Returns:

None

prepare(task)[source]

Prepare the deployment environment for the task’s node.

If preparation of the deployment environment ahead of time is possible, this method should be implemented by the driver.

If implemented, this method must be idempotent. It may be called multiple times for the same node on the same conductor.

This method is called before deploy.

Parameters:task – a TaskManager instance containing the node to act on.
prepare_cleaning(task)[source]

Prepare the node for cleaning tasks.

For example, nodes that use the Ironic Python Agent will need to boot the ramdisk in order to do in-band cleaning tasks.

If the function is asynchronous, the driver will need to handle settings node.driver_internal_info[‘clean_steps’] and node.clean_step, as they would be set in ironic.conductor.manager._do_node_clean, but cannot be set when this is asynchronous. After, the interface should make an RPC call to continue_node_cleaning to start cleaning.

NOTE(JoshNang) this should be moved to BootInterface when it gets implemented.

Parameters:task – a TaskManager instance containing the node to act on.
Returns:If this function is going to be asynchronous, should return states.CLEANWAIT. Otherwise, should return None. The interface will need to call _get_cleaning_steps and then RPC to continue_node_cleaning
take_over(task)[source]

Take over management of this task’s 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 containing the node to act on.
tear_down(task)[source]

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

Given a node that has been previously deployed to, do all cleanup and tear down necessary to “un-deploy” that node.

Parameters:task – a TaskManager instance containing the node to act on.
Returns:status of the deploy. One of ironic.common.states.
tear_down_cleaning(task)[source]

Tear down after cleaning is completed.

Given that cleaning is complete, do all cleanup and tear down necessary to allow the node to be deployed to again.

NOTE(JoshNang) this should be moved to BootInterface when it gets implemented.

Parameters:task – a TaskManager instance containing the node to act on.
class ironic.drivers.base.InspectInterface[source]

Bases: ironic.drivers.base.BaseInterface

Interface for inspection-related actions.

inspect_hardware(task)[source]

Inspect hardware.

Inspect hardware to obtain the essential & additional hardware properties.

Parameters:task – a task from TaskManager.
Raises:HardwareInspectionFailure, if unable to get essential hardware properties.
Returns:resulting state of the inspection i.e. states.MANAGEABLE or None.
class ironic.drivers.base.ManagementInterface[source]

Bases: ironic.drivers.base.BaseInterface

Interface for management related actions.

get_boot_device(task)[source]

Get the current boot device for a node.

Provides the current boot device of the node. Be aware that not all drivers support this.

Parameters:task – a task from TaskManager.
Raises:MissingParameterValue if a required parameter is missing
Returns:a dictionary containing:
boot_device:the boot device, one of ironic.common.boot_devices or None if it is unknown.
persistent:Whether the boot device will persist to all future boots or not, None if it is unknown.
get_sensors_data(task)[source]

Get sensors data method.

Parameters:task – a TaskManager instance.
Raises:FailedToGetSensorData when getting the sensor data fails.
Raises:FailedToParseSensorData when parsing sensor data fails.
Returns:returns a consistent format dict of sensor data grouped by sensor type, which can be processed by Ceilometer. eg,
{
  'Sensor Type 1': {
    'Sensor ID 1': {
      'Sensor Reading': 'current value',
      'key1': 'value1',
      'key2': 'value2'
    },
    'Sensor ID 2': {
      'Sensor Reading': 'current value',
      'key1': 'value1',
      'key2': 'value2'
    }
  },
  'Sensor Type 2': {
    'Sensor ID 3': {
      'Sensor Reading': 'current value',
      'key1': 'value1',
      'key2': 'value2'
    },
    'Sensor ID 4': {
      'Sensor Reading': 'current value',
      'key1': 'value1',
      'key2': 'value2'
    }
  }
}
get_supported_boot_devices(task)[source]

Get a list of the supported boot devices.

Parameters:task – a task from TaskManager.
Returns:A list with the supported boot devices defined in ironic.common.boot_devices.
inject_nmi(task)[source]

Inject NMI, Non Maskable Interrupt.

Inject NMI (Non Maskable Interrupt) for a node immediately.

Parameters:task – A TaskManager instance containing the node to act on.
Raises:UnsupportedDriverExtension
set_boot_device(task, device, persistent=False)[source]

Set the boot device for a node.

Set the boot device to use on next reboot of the node.

Parameters:
  • task – a task from TaskManager.
  • device – the boot device, one of ironic.common.boot_devices.
  • persistent – Boolean value. True if the boot device will persist to all future boots, False if not. Default: False.
Raises:

InvalidParameterValue if an invalid boot device is specified.

Raises:

MissingParameterValue if a required parameter is missing

class ironic.drivers.base.NetworkInterface[source]

Bases: ironic.drivers.base.BaseInterface

Base class for network interfaces.

add_cleaning_network(task)[source]

Add the cleaning network to a node.

Parameters:task – A TaskManager instance.
Returns:a dictionary in the form {port.uuid: neutron_port[‘id’]}
Raises:NetworkError
add_provisioning_network(task)[source]

Add the provisioning network to a node.

Parameters:task – A TaskManager instance.
Raises:NetworkError
add_rescuing_network(task)[source]

Add the rescuing network to the node.

Parameters:task – A TaskManager instance.
Returns:a dictionary in the form {port.uuid: neutron_port[‘id’]}
Raises:NetworkError
Raises:InvalidParameterValue, if the network interface configuration is invalid.
configure_tenant_networks(task)[source]

Configure tenant networks for a node.

Parameters:task – A TaskManager instance.
Raises:NetworkError
get_current_vif(task, p_obj)[source]

Returns the currently used VIF associated with port or portgroup

We are booting the node only in one network at a time, and presence of cleaning_vif_port_id means we’re doing cleaning, of provisioning_vif_port_id - provisioning, of rescuing_vif_port_id - rescuing. Otherwise it’s a tenant network.

Parameters:
  • task – A TaskManager instance.
  • p_obj – Ironic port or portgroup object.
Returns:

VIF ID associated with p_obj or None.

get_properties()[source]

Return the properties of the interface.

Returns:dictionary of <property name>:<property description> entries.
port_changed(task, port_obj)[source]

Handle any actions required when a port changes

Parameters:
  • task – a TaskManager instance.
  • port_obj – a changed Port object.
Raises:

Conflict, FailedToUpdateDHCPOptOnPort

portgroup_changed(task, portgroup_obj)[source]

Handle any actions required when a port changes

Parameters:
  • task – a TaskManager instance.
  • portgroup_obj – a changed Port object.
Raises:

Conflict, FailedToUpdateDHCPOptOnPort

remove_cleaning_network(task)[source]

Remove the cleaning network from a node.

Parameters:task – A TaskManager instance.
Raises:NetworkError
remove_provisioning_network(task)[source]

Remove the provisioning network from a node.

Parameters:task – A TaskManager instance.
remove_rescuing_network(task)[source]

Removes the rescuing network from a node.

Parameters:task – A TaskManager instance.
Raises:NetworkError
Raises:InvalidParameterValue, if the network interface configuration is invalid.
Raises:MissingParameterValue, if some parameters are missing.
unconfigure_tenant_networks(task)[source]

Unconfigure tenant networks for a node.

Parameters:task – A TaskManager instance.
validate(task)[source]

Validates the network interface.

Parameters:task – a TaskManager instance.
Raises:InvalidParameterValue, if the network interface configuration is invalid.
Raises:MissingParameterValue, if some parameters are missing.
validate_rescue(task)[source]

Validates the network interface for rescue operation.

Parameters:task – a TaskManager instance.
Raises:InvalidParameterValue, if the network interface configuration is invalid.
Raises:MissingParameterValue, if some parameters are missing.
vif_attach(task, vif_info)[source]

Attach a virtual network interface to a node

Parameters:
  • task – A TaskManager instance.
  • vif_info – a dictionary of information about a VIF. It must have an ‘id’ key, whose value is a unique identifier for that VIF.
Raises:

NetworkError, VifAlreadyAttached, NoFreePhysicalPorts

vif_detach(task, vif_id)[source]

Detach a virtual network interface from a node

Parameters:
  • task – A TaskManager instance.
  • vif_id – A VIF ID to detach
Raises:

NetworkError, VifNotAttached

vif_list(task)[source]

List attached VIF IDs for a node

Parameters:task – A TaskManager instance.
Returns:List of VIF dictionaries, each dictionary will have an ‘id’ entry with the ID of the VIF.
class ironic.drivers.base.PowerInterface[source]

Bases: ironic.drivers.base.BaseInterface

Interface for power-related actions.

get_power_state(task)[source]

Return the power state of the task’s node.

Parameters:task – a TaskManager instance containing the node to act on.
Raises:MissingParameterValue if a required parameter is missing.
Returns:a power state. One of ironic.common.states.
get_supported_power_states(task)[source]

Get a list of the supported power states.

Parameters:task – A TaskManager instance containing the node to act on.
Returns:A list with the supported power states defined in ironic.common.states.
reboot(task, timeout=None)[source]

Perform a hard reboot of the task’s node.

Drivers are expected to properly handle case when node is powered off by powering it on.

Parameters:
  • task – a TaskManager instance containing the node to act on.
  • timeout – timeout (in seconds) positive integer (> 0) for any power state. None indicates to use default timeout.
Raises:

MissingParameterValue if a required parameter is missing.

set_power_state(task, power_state, timeout=None)[source]

Set the power state of the task’s node.

Parameters:
  • task – a TaskManager instance containing the node to act on.
  • power_state – Any power state from ironic.common.states.
  • timeout – timeout (in seconds) positive integer (> 0) for any power state. None indicates to use default timeout.
Raises:

MissingParameterValue if a required parameter is missing.

class ironic.drivers.base.RAIDInterface[source]

Bases: ironic.drivers.base.BaseInterface

create_configuration(task, create_root_volume=True, create_nonroot_volumes=True)[source]

Creates RAID configuration on the given node.

This method creates a RAID configuration on the given node. It assumes that the target RAID configuration is already available in node.target_raid_config. Implementations of this interface are supposed to read the RAID configuration from node.target_raid_config. After the RAID configuration is done (either in this method OR in a call-back method), ironic.common.raid.update_raid_info() may be called to sync the node’s RAID-related information with the RAID configuration applied on the node.

Parameters:
  • task – a TaskManager instance.
  • create_root_volume – Setting this to False indicates not to create root volume that is specified in the node’s target_raid_config. Default value is True.
  • create_nonroot_volumes – Setting this to False indicates not to create non-root volumes (all except the root volume) in the node’s target_raid_config. Default value is True.
Returns:

states.CLEANWAIT if RAID configuration is in progress asynchronously or None if it is complete.

delete_configuration(task)[source]

Deletes RAID configuration on the given node.

This method deletes the RAID configuration on the give node. After RAID configuration is deleted, node.raid_config should be cleared by the implementation.

Parameters:task – a TaskManager instance.
Returns:states.CLEANWAIT if deletion is in progress asynchronously or None if it is complete.
get_logical_disk_properties()[source]

Get the properties that can be specified for logical disks.

This method returns a dictionary containing the properties that can be specified for logical disks and a textual description for them.

Returns:A dictionary containing properties that can be mentioned for logical disks and a textual description for them.
get_properties()[source]

Return the properties of the interface.

Returns:dictionary of <property name>:<property description> entries.
validate(task)[source]

Validates the RAID Interface.

This method validates the properties defined by Ironic for RAID configuration. Driver implementations of this interface can override this method for doing more validations (such as BMC’s credentials).

Parameters:task – a TaskManager instance.
Raises:InvalidParameterValue, if the RAID configuration is invalid.
Raises:MissingParameterValue, if some parameters are missing.
validate_raid_config(task, raid_config)[source]

Validates the given RAID configuration.

This method validates the given RAID configuration. Driver implementations of this interface can override this method to support custom parameters for RAID configuration.

Parameters:
  • task – a TaskManager instance.
  • raid_config – The RAID configuration to validate.
Raises:

InvalidParameterValue, if the RAID configuration is invalid.

class ironic.drivers.base.RescueInterface[source]

Bases: ironic.drivers.base.BaseInterface

Interface for rescue-related actions.

clean_up(task)[source]

Clean up the rescue environment for the task’s node.

This is particularly useful for nodes where rescuing is asynchronous and a timeout occurs.

Parameters:task – a TaskManager instance containing the node to act on.
Returns:None
rescue(task)[source]

Boot the task’s node into a rescue environment.

Parameters:task – a TaskManager instance containing the node to act on.
Raises:InstanceRescueFailure if node validation or rescue operation fails.
Returns:states.RESCUEWAIT if rescue is in progress asynchronously or states.RESCUE if it is complete.
unrescue(task)[source]

Tear down the rescue environment, and return to normal.

Parameters:task – a TaskManager instance containing the node to act on.
Raises:InstanceUnrescueFailure if node validation or unrescue operation fails.
Returns:states.ACTIVE if it is successful.
class ironic.drivers.base.StorageInterface[source]

Bases: ironic.drivers.base.BaseInterface

Base class for storage interfaces.

attach_volumes(task)[source]

Informs the storage subsystem to attach all volumes for the node.

Parameters:task – a TaskManager instance.
Raises:UnsupportedDriverExtension
detach_volumes(task)[source]

Informs the storage subsystem to detach all volumes for the node.

Parameters:task – a TaskManager instance.
Raises:UnsupportedDriverExtension
should_write_image(task)[source]

Determines if deploy should perform the image write-out.

Parameters:task – a TaskManager instance.
Returns:Boolean value to indicate if the interface expects the image to be written by Ironic.
Raises:UnsupportedDriverExtension
class ironic.drivers.base.VendorInterface[source]

Bases: ironic.drivers.base.BaseInterface

Interface for all vendor passthru functionality.

Additional vendor- or driver-specific capabilities should be implemented as a method in the class inheriting from this class and use the @passthru or @driver_passthru decorators.

Methods decorated with @driver_passthru should be short-lived because it is a blocking call.

driver_validate(method, **kwargs)[source]

Validate driver-vendor-passthru actions.

If invalid, raises an exception; otherwise returns None.

Parameters:
  • method – method to be validated
  • kwargs – info for action.
Raises:

MissingParameterValue if kwargs does not contain certain parameter.

Raises:

InvalidParameterValue if parameter does not match.

validate(task, method=None, **kwargs)[source]

Validate vendor-specific actions.

If invalid, raises an exception; otherwise returns None.

Parameters:
  • task – a task from TaskManager.
  • method – method to be validated
  • kwargs – info for action.
Raises:

UnsupportedDriverExtension if ‘method’ can not be mapped to the supported interfaces.

Raises:

InvalidParameterValue if kwargs does not contain ‘method’.

Raises:

MissingParameterValue

class ironic.drivers.base.VendorMetadata(method, metadata)

Bases: tuple

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.