Reference¶
Everything on these pages is generated from the code, so it always matches the release you run.
| Page | Generated from |
|---|---|
| Custom resources | the Go API types (api/v1alpha1) with crd-ref-docs |
| REST API | the OpenAPI document api/openapi/v1.yaml (also served by every Tenax at /api/v1/openapi.yaml) |
| CLI | the Cobra commands of the tenax binary |
| Metrics | the Prometheus collectors Tenax registers |
| Helm values | the chart's values.yaml |
make docs-reference regenerates them, and make lint fails when they are out of date.