Reference
Generated from the code, so it describes the build you are reading about. make docs-gen regenerates every page here and CI fails when one is stale.
| Reference | Generated from |
|---|---|
| Settings | the settings metadata table, internal/config/schema.go (kudurru config schema) |
| CRDs | the OpenAPI v3 schemas of config/crd/bases (make manifests) |
| CLI | the kudurru command tree (kudurru --help) |
| REST API | the OpenAPI document api/openapi.json (make openapi) |
- Settings reference
Every key of kudurru.yaml with its type, default, scope and environment variable.
- CRD reference
The kudurru.io custom resources: every field, its type and its validation.
- CLI reference
Every kudurru command, its arguments and its flags.
- REST API reference
The
/api/v1contract: authentication, the response envelope, errors, paging and streaming. Every route is in the OpenAPI document.