Introduction
Quick Start
Concepts
Personas
1.
Tasks
1.1.
Certificate Management
1.1.1.
Using Custom Certificates
1.1.2.
Generating a Kubeconfig
1.2.
Kubeadm based bootstrap
1.3.
Upgrading management and workload clusters
1.4.
Upgrading Cluster API components
1.5.
Configure a MachineHealthCheck
1.6.
Kubeadm based control plane management
1.7.
Updating Machine Infrastructure and Bootstrap Templates
1.8.
Using the Cluster Autoscaler
1.9.
Experimental Features
1.9.1.
MachinePools
1.9.2.
ClusterResourceSet
1.9.3.
ClusterClass
1.9.3.1.
Writing a ClusterClass
1.9.3.2.
Changing a ClusterClass
1.9.3.3.
Operating a managed Cluster
1.9.4.
Ignition Bootstrap configuration
2.
clusterctl CLI
2.1.
clusterctl Commands
2.1.1.
init
2.1.2.
generate cluster
2.1.3.
generate yaml
2.1.4.
get kubeconfig
2.1.5.
describe cluster
2.1.6.
move
2.1.7.
upgrade
2.1.8.
delete
2.1.9.
completion
2.1.10.
alpha rollout
2.1.11.
alpha topology plan
2.2.
clusterctl Configuration
2.3.
clusterctl Provider Contract
2.4.
clusterctl for Developers
3.
Developer Guide
3.1.
Repository Layout
3.2.
Rapid iterative development with Tilt
3.3.
Testing
3.4.
Developing E2E tests
3.5.
Controllers
3.5.1.
Bootstrap
3.5.2.
Cluster
3.5.3.
Machine
3.5.4.
MachineSet
3.5.5.
MachineDeployment
3.5.6.
MachineHealthCheck
3.5.7.
Control Plane
3.5.8.
MachinePool
3.5.9.
ClusterTopology
3.5.10.
Metadata propagation
3.5.11.
Multi-tenancy
3.5.12.
Support multiple instances
3.6.
Provider Implementers
3.6.1.
v1alpha1 to v1alpha2
3.6.2.
v1alpha2 to v1alpha3
3.6.3.
v1alpha3 to v1alpha4
3.6.4.
v1alpha4 to v1beta1
3.6.5.
v1.0 to v1.1
3.6.6.
Cluster Infrastructure
3.6.7.
Machine Infrastructure
3.6.8.
Bootstrap
3.6.9.
Implementer's Guide
3.6.9.1.
Naming
3.6.9.2.
Create Repo and Generate CRDs
3.6.9.3.
Create API
3.6.9.4.
Controllers and Reconciliation
3.6.9.5.
Building, Running, Testing
3.7.
CustomResourceDefinitions relationships
4.
Troubleshooting
5.
Reference
5.1.
Glossary
5.2.
Provider List
5.3.
Ports
5.4.
Code of Conduct
5.5.
Contributing
5.6.
Jobs
5.7.
Code Review in Cluster API
5.8.
Version Support
5.9.
Roadmap
Light (default)
Rust
Coal
Navy
Ayu
The Cluster API Book
Repository Layout
This page is still being written - stay tuned!