Reference
This section holds the material you look up rather than read through. You come
here with a specific question, such as what a vcluster.yaml field defaults to,
which Kubernetes versions a release supports, or what an annotation means. To
configure a cluster step by step, start in
Configure instead. Its pages link to the
fields they use.
Generated and hand-written reference​
The vcluster.yaml reference and the CLI command pages are generated from the configuration schema and the CLI's own help on each release, so they cover every field and every command. The other pages here are written by hand and cover what spans the product, such as the lifecycle policy, annotations, and the glossary.
Find what you're looking for​
| Looking for | Go to |
|---|---|
A vcluster.yaml field, its type, and its default | vcluster.yaml reference, grouped by top-level key |
| A CLI command and its flags | CLI, with a page for every command |
| An annotation or label on a synced resource | Annotations and labels |
| Supported releases, LTS, feature stages, or Kubernetes compatibility | Lifecycle policy |
| Breaking changes from older releases | v0.20 migration, v0.20 CLI changes, and Loft CLI to vCluster CLI |
| A term used in these docs | Glossary |
| Docs search from an AI assistant | Algolia MCP, for assistants that support MCP |
| How to propose a change to these docs | Contribute to vCluster docs |
The Platform API, Platform annotations, and licensing are in the vCluster Platform Reference.