baremetal-operator

README

Bare Metal Operator

The Bare Metal Operator implements a Kubernetes API for managing bare metal hosts. It maintains an inventory of available hosts as instances of the BareMetalHost Custom Resource Definition. The Bare Metal Operator knows how to:

• Inspect the host’s hardware details and report them on the corresponding BareMetalHost. This includes information about CPUs, RAM, disks, NICs, and more.
• Provision hosts with a desired image
• Clean a host’s disk contents before or after provisioning.

More capabilities are being added regularly. See open issues and pull requests for more information on work in progress.

For more information about Metal³, the Bare Metal Operator, and other related components, see the Metal³ docs.

Resources

• API documentation
• Setup Development Environment
• Configuration
• Testing
• Publishing Images

Important Notes

Whenever there is a change in config/ directory, please remember to run the following command:

make manifests

This will render the config/render/capm3.yaml. Please do not change the content of config/render/capm3.yaml manually.