Skip to content

The CAPTF book is online

The documentation for Cluster API Provider Terraform now has a home of its own at captf.io/docs. It covers what CAPTF is and how it works, how to run clusters with it, how to write a module for it, and how to operate the manager.

What is in it

  • Getting started. A Quick Start that installs the provider and brings up a cluster with the no-op modules, on any Kubernetes cluster and with no cloud account, and a tutorial that takes you through your first module.
  • Concepts. The architecture, the kinds, Terraform state, secrets, approvals, jobs and deletion, each explained from the controller’s side.
  • Guides. How to provide credentials, pass module variables, use ClusterClass templates, run machine pools, and handle drift and plan approval.
  • The module contract. The v1alpha1 contract every module is written to, with its changelog, and integration guides for the kubeadm and RKE2 control planes.
  • Operations and runbooks. Installation, configuration, observability, upgrades and recovery, and runbooks for failing Jobs, stuck destroys, stale locks and more.
  • Reference. The API, conditions, events, metrics, alerts and flags, generated from the provider’s source so they stay in step with it.

Status

Every kind and the module contract are v1alpha1 and pre-release: the contract is frozen for implementation but may still change. CAPTF has no end-to-end tests yet. The Known Limitations page lists everything it does not do.