openstack/ironic-python-agent
Code Issues Proposed changes

doc: How hardware managers ignore certain devices

Browse Source 
Overriding or implementing `filter_device` activates filtering.
Otherwise, GenericHardwareManager returns the device unchanged,
effectively skipping filtering.

Related-Bug: #2117234
Change-Id: Ifdda007e0c5001ab7df38c2c510e3f40c110d03c
Signed-off-by: Afonne-CID <afonnepaulc@gmail.com>
This commit is contained in:
Afonne-CID
2025-07-21 13:04:23 +01:00
parent 780cf3615d
commit b4ae46d24a
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/contributor/hardware_managers.rst
View File

@@ -28,6 +28,17 @@ passed on to whatever dispatched the method. If the method is unable to run
successfully on any hardware managers, ``HardwareManagerMethodNotFound`` is
raised.
Some methods, such as ``filter_device``, are expected to return ``None`` to
indicate a negative result (i.e., to exclude a device) which happens when
one or more hardware managers override the method and at least one
explicitly returns ``None``. If dispatch ever reaches the generic manager,
the device is returned without filtering.
This design allows granular control over filtering. To avoid unintentionally
excluding devices, hardware managers must either return the device (or a
modified copy), raise ``IncompatibleHardwareMethodError``, or refrain from
overriding the method at all.
Why build a custom HardwareManager?
-----------------------------------
Custom hardware managers allow you to include hardware-specific tools, files