Reference
This section holds the material you look up rather than read through. You come here with a specific question, such as what an API resource's fields are, how the platform refreshes its license, or what an annotation means. To set up or run the platform step by step, start in Administer the management plane instead. Its pages link to the fields they use.
Generated and hand-written reference​
The API section is generated from the doc comments on the API's resource types on each release, so it covers every resource the management API serves. The other pages here are written by hand and cover what spans the product, such as licensing, the lifecycle policy, annotations, and the glossary.
Find what you're looking for​
| Looking for | Go to |
|---|---|
A field in the config section of the platform's values.yaml | Platform config |
| An API resource and how to call it | API, with a page for every resource |
| A platform CLI command and its UI equivalent | Platform CLI hub |
A loft.sh annotation or label | Platform annotations and labels |
| Supported releases, LTS, or feature stages | Lifecycle policy |
| How the platform gets its license, and what happens when licensing is unavailable | How licensing works |
| 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 Platform docs |
The vcluster.yaml reference, vCluster annotations, and the full vcluster
command reference are in the vCluster Reference.