Skip to content

docs: add contributor guide for writing Ironic drivers and interfaces - #2315

Open
cardoe wants to merge 1 commit into
mainfrom
docs/writing-ironic-drivers-guide
Open

docs: add contributor guide for writing Ironic drivers and interfaces#2315
cardoe wants to merge 1 commit into
mainfrom
docs/writing-ironic-drivers-guide

Conversation

@cardoe

@cardoe cardoe commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

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

  • This change requires operator action to upgrade. If checked, add the
    upgrade-impact label and a release note: run scriv create from the
    repository 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.

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
cardoe force-pushed the docs/writing-ironic-drivers-guide branch from 6ba932e to 6af7c67 Compare September 8, 2026 20:39
@cardoe
cardoe marked this pull request as ready for review September 8, 2026 20:39
@cardoe
cardoe requested a review from a team September 8, 2026 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant