Files
ironic-python-agent/doc/source/admin/hardware_managers.rst
Dmitry Tantsur ffacb713e5 Document in-band deploy steps and add more docs for custom steps
Change-Id: I304a460f88f3f8ee33cf642355f0e659184db724
Story: #2006963
Task: #40727
2020-08-24 17:39:54 +02:00

1.9 KiB

Built-in hardware managers

GenericHardwareManager

This is the default hardware manager for ironic-python-agent. It provides support for hardware-inventory and the default deploy and clean steps.

Deploy steps

deploy.write_image(node, ports, image_info, configdrive=None)

A deploy step backing the write_image deploy step of the direct deploy interface <admin/interfaces/deploy.html#direct-deploy>. Should not be used explicitly, but can be overridden to provide a custom way of writing an image.

deploy.erase_device_metadata(node, ports)

Erases partition tables from all recognized disk devices. Can be used with software RAID since it requires empty holder disks.

raid.apply_configuration(node, ports, raid_config, delete_existing=True)

Apply a software RAID configuration. It belongs to the raid interface and must be used through the ironic RAID feature <admin/raid.html>.

Clean steps

deploy.erase_devices

Securely erases all information from all recognized disk devices. Relatively fast when secure ATA erase is available, otherwise can take hours, especially on a virtual environment. Enabled by default.

deploy.erase_device_metadata

Erases partition tables from all recognized disk devices. Can be used as an alternative to the much longer erase_devices step.

raid.create_configuration

Create a RAID configuration. This step belongs to the raid interface and must be used through the ironic RAID feature <admin/raid.html>.

raid.delete_configuration

Delete the RAID configuration. This step belongs to the raid interface and must be used through the ironic RAID feature <admin/raid.html>.