Reference
Reference
Reference pages describe the machinery; they do not tell you what to do with it. Pages marked
generated are produced from the source of truth by task docs / task rbac-gen and checked
in CI — edit the source, not the page.
| Page | Contents | Source |
|---|---|---|
| CRD reference | Every spec and status field of the five kinds, with types, defaults and constraints | generated from deploy/crds |
| Chart values | Every Helm value with default and description | generated by helm-docs |
| RBAC reference | Every rule the default chart grants, by role and binding | generated from the rendered chart |
| Compatibility | Supported Kubernetes and Headscale versions, verified platforms, test coverage | curated |
| TailnetGateway contract | What a gateway advertises, how routes/DNS/BGP are wired, status semantics | curated |
| Metrics | Operator and agent Prometheus metrics with labels | curated |
| Alerts | The alert rules the chart ships, with links to their runbooks | curated |
| Conditions and reasons | Condition types and the reasons each kind reports | curated |
| Changelog | Release notes | repository root |
Source: docs/reference/README.md at v0.18.0 — found a mistake? Tell us.