The Metal³ project (pronounced: Metal Kubed) exists to provide components that allow you to do bare metal host management for Kubernetes. Metal³ works as a Kubernetes application, meaning it runs on Kubernetes and is managed through Kubernetes interfaces.
Metal³ Component Overview
Machine API Integration
Another set of components is being designed and built to provide integration with the Kubernetes Machine API.
This first diagram represents the high level architecture:
Machine API Actuator
The first component is the Bare Metal
is an implementation of the Machine Actuator interface defined by the
cluster-api project. This actuator reacts to changes to Machine objects and
acts as a client of the
BareMetalHost custom resources managed by the Bare
Bare Metal Operator
The architecture also includes a new Bare Metal Operator, which includes the following:
- A Controller for a new Custom Resource,
BareMetalHost. This custom resource represents an inventory of known (configured or automatically discovered) bare metal hosts. When a Machine is created the Bare Metal Actuator will claim one of these hosts to be provisioned as a new Kubernetes node.
- In response to
BareMetalHostupdates, will perform bare metal host provisioning actions as necessary to reach the desired state. It will do so by managing and driving a set of underlying bare metal provisioning components.
- The implementation will focus on using Ironic as its first implementation of the Bare Metal Management Pods, but aims to keep this as an implementation detail under the hood such that alternatives could be added in the future if the need arises.
The creation of the
BareMetalHost inventory can be done in two ways:
- Manually via creating
- Optionally, automatically created via a bare metal host discovery process. Ironic is capable of doing this, which will also be integrated into Metal³ as an option.
For more information about Operators, see the operator-sdk.
Enroll nodes by creating
BareMetalHostresources. This would either be manually or done by a component doing node discovery and introspection.
See the documentation in the baremetal-operator repository for details.
Use the machine API to allocate a machine.
apiVersion: "cluster.k8s.io/v1alpha1" kind: Machine metadata: generateName: baremetal-master- labels: set: master spec: providerSpec: value: apiVersion: "baremetalproviderconfig/v1alpha1" kind: "BareMetalProviderConfig" selector: node-profile: master apiVersion: "cluster.k8s.io/v1alpha1" kind: Machine metadata: generateName: baremetal-node- labels: set: node spec: providerSpec: value: apiVersion: "baremetalproviderconfig/v1alpha1" kind: "BareMetalProviderConfig" selector: node-profile: node
- Machine is associated with an available
BareMetalHost, which triggers provisioning of that host to join the cluster. This association is done by the Actuator when it sets the
MachineReffield on the