docs: add contributor guide for writing Ironic drivers and interfaces - #2315
Open
cardoe wants to merge 1 commit into
Open
docs: add contributor guide for writing Ironic drivers and interfaces#2315cardoe wants to merge 1 commit into
cardoe wants to merge 1 commit into
Conversation
Contributors adding hardware support to ironic-understack currently have no Ironic-specific onboarding: the hardware-type/interface model, the provisioning state machine, and the mixin pattern the existing drivers use are undocumented outside upstream OpenStack docs and the source itself. Cover that ground, with extra depth on writing an inspect/ management interface for devices that have no BMC or deploy ramdisk (e.g. network gear), since that's the next class of driver expected.
cardoe
force-pushed
the
docs/writing-ironic-drivers-guide
branch
from
September 8, 2026 20:39
6ba932e to
6af7c67
Compare
cardoe
marked this pull request as ready for review
September 8, 2026 20:39
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this change do?
Contributors adding hardware support to ironic-understack currently have
no Ironic-specific onboarding: the hardware-type/interface model, the
provisioning state machine, and the mixin pattern the existing drivers
use are undocumented outside upstream OpenStack docs and the source
itself. Cover that ground, with extra depth on writing an inspect/
management interface for devices that have no BMC or deploy ramdisk
(e.g. network gear), since that's the next class of driver expected.
Upgrade impact
upgrade-impactlabel and a release note: runscriv createfrom therepository root and describe the required action in the generated
changelog.d/file. See RELEASING.md.Operator action means anything a deployment has to do beyond a normal resync:
deploy repo or values changes, new or removed secrets, enabling or disabling a
component, or a manual one-time step.