Documentation

The first component is the Bare Metal Actuator, which 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 Metal

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 BareMetalHost updates, the controller will perform bare metal host provisioning actions as necessary to reach the desired state. The creation of the BareMetalHost inventory can be done in two ways:

1. Manually via creating BareMetalHost objects.
2. Optionally, automatically created via a bare metal host discovery process. For more information about Operators, see the operator-sdk.

The operator manages a set of tools for controlling the power on the host, monitoring the host status, and provisioning images to the host. These tools run inside the pod with the operator, and do not require any configuration by the user.