rke2spray Documentation

Install and operate RKE2 clusters while retaining the Kubespray public API and familiar workflows.

Core summary

rke2spray translates the Kubespray Inventory, Playbook, and Role API into RKE2 server and agent lifecycles.
New users should follow the getting-started guide from preflight checks through the first cluster convergence.
Existing Kubespray users should review the architecture and compatibility boundaries before reusing inputs.
Every operational change starts with Vault validation, Inventory preflight, and a cluster health check.
The machine-readable compatibility contract and support matrix remain the final authority for supported inputs.

In one sentence

Use the Kubespray public API while running RKE2 as the execution engine.

Move from prerequisites to the first cluster.yml run.

Understand how Kubespray names translate into RKE2 behavior.

Define node roles, variable ownership, and secret boundaries.

Look up version, CNI, endpoint, datastore, and registry inputs.

Run scaling, upgrades, snapshots, recovery, and removal.

Distinguish supported, adapter, conditional, and rejected APIs.

This site reorganizes repository documentation into a fast operator-facing navigation layer.
When variables or support status differ, prefer the current release and docs/kubespray-api-compatibility.yml.
Environment-specific Inventory and Vault ciphertext belong to a consuming environment repository, not the reusable rke2spray core.