Cluster API Provider for Managed Bare Metal Hardware

This repository contains a Machine actuator implementation for the Kubernetes Cluster API.

For more information about this actuator and related repositories, see metal3.io.

Compatibility with Cluster API

CAPM3 version	Cluster API version	CAPM3 Release
v1alpha2	v1alpha2	v0.2.X
v1alpha3	v1alpha3	v0.3.X
v1alpha4	v1alpha3	v0.4.X

You can find information on how to use this provider with Cluster API and clusterctl in the getting-started.

Deploying the metal3 provider

The recommended method is using Clusterctl. Please refer to the getting-started for the pre-requisites.

Development Environment

There are multiple ways to setup a development environment:

• Using Tilt
• Other management cluster
• See metal3-dev-env for an end-to-end development and test environment for cluster-api-provider-metal3 and baremetal-operator.

API

See the API Documentation for details about the objects used with this cluster-api provider. You can also see the cluster deployment workflow for the outline of the deployment process.

Architecture

The architecture with the components involved is documented here