Introduction
Quick Start
Concepts
Personas
1.
Tasks
1.1.
Certificate Management
1.1.1.
Using Custom Certificates
1.1.2.
Generating a Kubeconfig
1.1.3.
Auto Rotate Certificates in KCP
1.2.
Bootstrap
1.2.1.
Kubeadm based bootstrap
1.2.2.
MicroK8s based bootstrap
1.3.
Upgrading management and workload clusters
1.4.
External etcd
1.5.
Using kustomize
1.6.
Upgrading Cluster API components
1.7.
Control plane management
1.7.1.
Kubeadm based control plane management
1.7.2.
MicroK8s based control plane management
1.8.
Updating Machine Infrastructure and Bootstrap Templates
1.9.
Automated Machine management
1.9.1.
Scaling
1.9.2.
Autoscaling
1.9.3.
Healthchecking
1.10.
Experimental Features
1.10.1.
MachinePools
1.10.2.
ClusterResourceSet
1.10.3.
ClusterClass
1.10.3.1.
Writing a ClusterClass
1.10.3.2.
Changing a ClusterClass
1.10.3.3.
Operating a managed Cluster
1.10.4.
Runtime SDK
1.10.4.1.
Implementing Runtime Extensions
1.10.4.2.
Implementing Lifecycle Hook Extensions
1.10.4.3.
Implementing Topology Mutation Hook Extensions
1.10.4.4.
Deploying Runtime Extensions
1.10.5.
Ignition Bootstrap configuration
1.11.
Running multiple providers
2.
Security Guidelines
2.1.
Pod Security Standards
3.
clusterctl CLI
3.1.
clusterctl Commands
3.1.1.
init
3.1.2.
generate cluster
3.1.3.
generate provider
3.1.4.
generate yaml
3.1.5.
get kubeconfig
3.1.6.
describe cluster
3.1.7.
move
3.1.8.
upgrade
3.1.9.
delete
3.1.10.
completion
3.1.11.
alpha rollout
3.1.12.
alpha topology plan
3.1.13.
additional commands
3.2.
clusterctl Configuration
3.3.
clusterctl Provider Contract
3.4.
clusterctl for Developers
4.
Developer Guide
4.1.
Repository Layout
4.2.
Rapid iterative development with Tilt
4.3.
Logging
4.4.
Testing
4.5.
Developing E2E tests
4.6.
Controllers
4.6.1.
Bootstrap
4.6.2.
Cluster
4.6.3.
Machine
4.6.4.
MachineSet
4.6.5.
MachineDeployment
4.6.6.
MachineHealthCheck
4.6.7.
Control Plane
4.6.8.
MachinePool
4.6.9.
ClusterTopology
4.6.10.
ClusterResourceSet
4.6.11.
Metadata propagation
4.6.12.
Multi-tenancy
4.6.13.
Support multiple instances
4.7.
Provider Implementers
4.7.1.
Version migration
4.7.1.1.
v0.3 to v0.4
4.7.1.2.
v0.4 to v1.0
4.7.1.3.
v1.0 to v1.1
4.7.1.4.
v1.1 to v1.2
4.7.1.5.
v1.2 to v1.3
4.7.2.
Provider contracts
4.7.2.1.
Cluster Infrastructure
4.7.2.2.
Machine Infrastructure
4.7.2.3.
Bootstrap
4.7.3.
Implementer's Guide
4.7.3.1.
Naming
4.7.3.2.
Configure
4.7.3.3.
Create Repo and Generate CRDs
4.7.3.4.
Create API
4.7.3.5.
Webhooks
4.7.3.6.
Controllers and Reconciliation
4.7.3.7.
Building, Running, Testing
4.8.
CustomResourceDefinitions relationships
5.
Troubleshooting
6.
Reference
6.1.
API Reference
6.2.
Glossary
6.3.
Provider List
6.4.
Ports
6.5.
Code of Conduct
6.6.
Contributing
6.7.
Jobs
6.8.
Code Review in Cluster API
6.9.
Version Support
6.10.
Roadmap
6.11.
Supported Labels and Annotations
Light (default)
Rust
Coal
Navy
Ayu
The Cluster API Book
Cluster API Roadmap
You can find the Cluster API roadmap discussion at
GitHub
. Please feel free to participate!