Skip to main content
Version: v5.0 Stable

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 forGo to
A field in the config section of the platform's values.yamlPlatform config
An API resource and how to call itAPI, with a page for every resource
A platform CLI command and its UI equivalentPlatform CLI hub
A loft.sh annotation or labelPlatform annotations and labels
Supported releases, LTS, or feature stagesLifecycle policy
How the platform gets its license, and what happens when licensing is unavailableHow licensing works
A term used in these docsGlossary
Docs search from an AI assistantAlgolia MCP, for assistants that support MCP
How to propose a change to these docsContribute to Platform docs

The vcluster.yaml reference, vCluster annotations, and the full vcluster command reference are in the vCluster Reference.