ironic-python-agent/examples
Riccardo Pittau efbbc86f53 Increase version of hacking and pycodestyle
Fix H904 "Delay string interpolations at logging calls" errors

Change-Id: I331808d0132094faf739998a6984440787d3ebf8
2021-07-30 14:34:33 +02:00
..
business-logic Increase version of hacking and pycodestyle 2021-07-30 14:34:33 +02:00
custom-disk-erase Add example for custom disk erasure 2020-11-02 15:46:19 -08:00
vendor-device Import example hardware managers from ipa-example-hardware-managers 2020-07-31 13:35:34 +02:00
README.rst Add example for custom disk erasure 2020-11-02 15:46:19 -08:00

Example Hardware Managers

vendor-device

This example manager is meant to demonstrate good patterns for developing a device-specific hardware manager, such as for a specific version of NIC or disk.

Use Cases include:

  • Adding device-specific clean-steps, such as to flash firmware or verify it's still properly working after being provisioned.
  • Implementing erase_device() using a vendor-provided utility for a given disk model.

custom-disk-erase

This example manager is meant to demonstrate good patterns for developing a hardware manager to perform disk erasure using a custom vendor utility.

Use case: * Ensuring block devices of a specific model are erased using custom code

business-logic

This example manager is meant to demonstrate how cleaning and the agent can use the node object and the node itself to enforce business logic and node consistency.

Use Cases include:

  • Quality control on hardware by ensuring no component is beyond its useful life.
  • Asserting truths about the node; such as number of disks or total RAM.
  • Reporting metrics about the node's hardware state.
  • Overriding logic of get_os_install_device().
  • Inserting additional deploy steps.

Make your own Manager based on these

To make your own hardware manager based on these examples, copy a relevant example out of this directory. Modify class names and entrypoints in setup.cfg to be not-examples.

Since the entrypoints are defined in setup.cfg, simply installing your new python package alongside IPA in a custom ramdisk should be enough to enable the new hardware manager.