How metal3-io/baremetal-operator works
Bare Metal Operator is a Kubernetes operator that manages bare-metal hosts through BareMetalHost resources. The principal workflow is a user submitting host intent to Kubernetes, after which the manager reconciles host state, invokes a provisioner for inspection or image provisioning, and reports status. Additional branches manage claims, preprovisioning images, firmware, network attachments, and BMC events. The README establishes the product capabilities; sampled source and the SOURCE INDEX show the manager, controllers, and Ironic integration. Some internal call paths are not shown, so uncertain links are omitted.
Main entry points: main.go Operator manager · baremetalhost_controller.go Host reconciliation · provisioner.go Provisioner interface · hostclaim_controller.go Claim reconciliation
Components 21
Kubernetes API
- Host resources
apis/metal3.io/v1alpha1/baremetalhost_types.go - Related resources
apis/metal3.io/v1alpha1/hostclaim_types.go - Admission validation
internal/webhooks/metal3.io/v1alpha1/baremetalhost_webhook.go - Host status
apis/metal3.io/v1alpha1/baremetalhost_types.go
Reconciliation
- Operator manager
main.go - Host reconciliation
internal/controller/metal3.io/baremetalhost_controller.go - Claim reconciliation
internal/controller/metal3.io/hostclaim_controller.go - Image reconciliation
pkg/controllers/preprovisioningimage_controller.go - BMC event reconciliation
internal/controller/metal3.io/bmceventsubscription_controller.go - Firmware reconciliation
internal/controller/metal3.io/hostfirmwarecomponents_controller.go - Firmware settings
internal/controller/metal3.io/hostfirmwaresettings_controller.go - Data image reconciliation
internal/controller/metal3.io/dataimage_controller.go - Switch reconciliation
internal/controller/metal3.io/baremetalswitch_controller.go
Host Provisioning
- Provisioner interface
pkg/provisioner/provisioner.go - Ironic provisioner
pkg/provisioner/ironic/ironic.go - BMC access
pkg/hardwareutils/bmc/access.go - Hardware inspection
pkg/provisioner/ironic/hardwaredetails/hardwaredetails.go
Host Services
- Host selection
pkg/hostclaim/hostclaim_manager.go - Image building
pkg/imageprovider/default.go
Other components
- Cluster user
- Kubernetes API
Connections 25
- Cluster user → Kubernetes API: submits intent
- Kubernetes API → Admission validation: validates changes
- Admission validation → Host resources: validates resource
internal/webhooks/metal3.io/v1alpha1/baremetalhost_webhook.go - Operator manager → Host reconciliation: registers controllers
main.go - Operator manager → Image reconciliation: registers controllers
main.go - Operator manager → Claim reconciliation: registers controllers
main.go - Operator manager → BMC event reconciliation: registers controllers
main.go - Operator manager → Firmware reconciliation: registers controllers
main.go - Operator manager → Firmware settings: registers controllers
main.go - Operator manager → Data image reconciliation: registers controllers
main.go - Operator manager → Switch reconciliation: registers controllers
- Kubernetes API → Host reconciliation: reconciles host
- Host reconciliation → Provisioner interface: invokes provisioning
- Provisioner interface → Ironic provisioner: implements interface
- Ironic provisioner → BMC access: accesses BMC
pkg/provisioner/ironic/ironic.go - Ironic provisioner → Hardware inspection: converts inventory
- Host reconciliation → Host status: reports host state
internal/controller/metal3.io/baremetalhost_controller.go - Host reconciliation → Image reconciliation: creates image resource
internal/controller/metal3.io/baremetalhost_controller.go - Image reconciliation → Image building: builds image
pkg/controllers/preprovisioningimage_controller.go - Claim reconciliation → Host selection: manages host claims
internal/controller/metal3.io/hostclaim_controller.go - Claim reconciliation → Related resources: reconciles claims
internal/controller/metal3.io/hostclaim_controller.go - BMC event reconciliation → Provisioner interface: uses provisioner
internal/controller/metal3.io/bmceventsubscription_controller.go - Firmware reconciliation → Provisioner interface: creates provisioner
internal/controller/metal3.io/hostfirmwarecomponents_controller.go - Firmware settings → Provisioner interface: creates provisioner
internal/controller/metal3.io/hostfirmwaresettings_controller.go - Host reconciliation → Host resources: reads host intent
internal/controller/metal3.io/baremetalhost_controller.go