cluster-api-provider-metal3

README

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	Release
v1alpha2	v1alpha2	v0.2.X
v1alpha3	v1alpha3	v0.3.X

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

Development Environment

• See metal3-dev-env for an end-to-end development and test environment for cluster-api-provider-metal3 and baremetal-operator.
• Setting up for tests

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

Deployment and examples

Deploy Bare Metal Operator CRDs and CRs

for testing purposes only, when Bare Metal Operator is not deployed

    make deploy-bmo-cr

Deploy CAPM3

Deploys CAPM3 CRDs and deploys CAPI, CABPK, CACPK and CAPM3 controllers

    make deploy

Run locally

Runs CAPM3 controller locally

    kubectl scale -n capm3-system deployment.v1.apps/capm3-controller-manager \
      --replicas 0
    make run

Deploy an example cluster

    make deploy-examples

Delete the example cluster

    make delete-examples