Reference¶
Exact facts about the operator's API, behaviour and packaging, for looking up while you work. Each page states where its facts come from in the code. For the mental model, read the concepts; for tasks, use the guides.
| page | look here for |
|---|---|
| API reference | every kind and field, generated from the CRD schemas, with an example per kind |
| Examples | the curated and generated example manifests, tested against the CRDs in CI |
| Kind catalogue | every kind with its OpenBao path, availability class, roadmap phase and test evidence |
| Constants and timings | drift intervals, backoffs, retry counts, rate shares, write budget, login and renewal points, with their source lines |
| API coverage | how many OpenBao API paths have a typed kind, per OpenBao release |
| Connections | OpenBaoServer, OpenBaoConnection and ClusterOpenBaoConnection fields, authentication methods, tenant boundary rules, TLS |
| Status and events | conditions, every reason and what to do about it, status fields, events, print columns |
| Helm values | every chart value with its type, default and constraints |
| Compatibility | supported and tested OpenBao, Kubernetes and Helm versions, image platforms, kind availability classes |
| Known limitations | what the current release does not do or does not verify, with workarounds |
Related pages outside this section:
| page | look here for |
|---|---|
| Observability | metrics, labels, example queries and alert rules, log flags |
| Troubleshooting | symptoms, checks and fixes |
| Architecture | the design rules the engine enforces |
| Decisions (ADRs) | why the design is the way it is |