Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Developer Guide

This section of the book focus on the developer guide for Cluster API.

Before starting, read Contributing to Cluster API carefully.

The getting started guide provides an overview about how to set up your development environment.

Please look at Developing “core” Cluster API if you are looking to contribute to “core” Cluster API;

Please note that in the Cluster API code base, side by side of “core” Cluster API components there is also a limited number of in-tree providers:

  • Kubeadm bootstrap provider (CAPBK)
  • Kubeadm control plane provider (KCP)
  • Docker infrastructure provider (CAPD) - The Docker provider is not designed for production use and is intended for development & test only.

Please refer to Developing providers for documentation about developing in-tree providers as well as out of tree providers too.