Reference¶
Exact names, fields and defaults. The pages marked generated are built from the sources in the repository, and CI fails when a committed page no longer matches its source.
| Page | What it lists | Source |
|---|---|---|
| Chart values | global.mode, the umbrella values, rules the schema enforces; one page per component chart: hub, web, pricing, agent, webhook (generated) |
deploy/charts/*/values.yaml, values.schema.json |
| Custom resources | RightsizingPolicy and RightsizingRecommendation, field by field (generated) |
api/v1alpha1, through api/crds |
| Hub API | Every endpoint, by area, with parameters, bodies and responses, and the schemas (generated) | api/openapi/hub.yaml |
| Metrics | The kerf_* metrics and the PromQL the recommender runs |
|
| Events | The audit trail: what the agent decided and did | |
| Admin area | Users, roles, tokens, policies and settings | |
| Readiness | Metrics sources and the per-cluster readiness checks |
To regenerate the pages after you change a source, run make docs-generate and commit the result.