Useful examples of HardwareManager plugins for ironic-python-agent
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jay Faulkner 8fc36d5a6a Merge pull request #1 from jayofdoom/jay/ExampleBusinessLogicManager 2 years ago
example_hardware_managers Add example business logic hardware manager 2 years ago
LICENSE Add example_device hwm and test harnesses 2 years ago
README.rst Add basic information on using these examples 2 years ago
requirements.txt Add example_device hwm and test harnesses 2 years ago
setup.cfg Add example business logic hardware manager 2 years ago
setup.py Add example_device hwm and test harnesses 2 years ago
test-requirements.txt Add example_device hwm and test harnesses 2 years ago
tox.ini Make dir name more clear 2 years ago

README.rst

ipa-example-hardware-managers

Example hardware managers for use with the ironic python agent.

Examples and Use Cases Provided

Example Device Hardware Manager

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.

Example Business Logic Hardware Manager

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().

Make your own Manager based on these

To make your own hardware manager based on these examples, copy or fork the relevant examples out of this repository. Modify classnames 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.