Compatibility¶
The versions and platforms each release supports and the ones CI tests. Sources: the chart's
Chart.yaml, the Makefile tool pins, .github/workflows/release.yml,
ADR 0009, ADR 0023
and the release process.
Summary¶
| component | declared compatibility | tested in CI |
|---|---|---|
| OpenBao | 2.6 and 2.7 under the release policy; minimum 2.6, with endpoint-specific limits | 2.7.2: integration tests run against bao server -dev (unit tests and envtest do not prove server compatibility) (BAO_VERSION in the Makefile); the e2e test runs ghcr.io/openbao/openbao:2.7.2 in kind (hack/e2e/openbao.yaml). 2.6 is covered by its OpenAPI snapshot (api-coverage/openapi-2.6.json) only |
| Kubernetes | 1.31 or later (chart kubeVersion: ">=1.31.0-0") |
envtest 1.35 (from k8s.io/api v0.35 in go.mod); kind node kindest/node:v1.35.8 with kind v0.33.0 in the e2e workflow (KIND_NODE_IMAGE and KIND_VERSION in the Makefile) |
| Helm | 3.8 or later, for OCI charts | Helm v4.3.1 (HELM_VERSION in the Makefile) for lint, unit tests and e2e |
| Image architectures | linux/amd64, linux/arm64 |
both are built and checked by hack/release/verify-release.sh |
OpenBao¶
Live compatibility is verified on 2.7.2. The 2.6 OpenAPI snapshot establishes that a path or field exists in that API description; it does not exercise authentication, defaults, reads, writes or deletion on a running 2.6 server. Treat 2.6 as a declared compatibility target with incomplete runtime evidence, and test the kinds you use before upgrading or deploying there. The API coverage report separates the two release inventories.
- OpenBao is the only target (ADR 0009). The design relies on OpenBao features: self-init, namespaces and OCI plugins. Other servers are not tested and not supported.
- Each operator minor supports the OpenBao minors that have an API snapshot in
api-coverage/and are listed in its release notes; todayopenapi-2.6.jsonandopenapi-2.7.json. - The integration suite runs against the single pinned version, 2.7.2. A scheduled run against every supported minor is not in place yet (BL-014).
- Adapters do not branch on the server version. Recognised unsupported endpoints or features report
Unsupported; other API validation failures may reportReconcileError(ADR 0023). OpenBaoServer.status.versionreports the version the server returns fromsys/health.- A new OpenBao minor is supported in the next operator minor after its snapshot is added and classified, with a target of six weeks after the OpenBao release. An OpenBao minor is dropped in the first operator minor after upstream stops releasing fixes for it, announced one minor ahead (release process).
OpenBao features the operator depends on¶
| feature | needed for |
|---|---|
cluster id in sys/health |
binding acquired objects to one server (status.serverID) |
| namespaces | OpenBaoNamespace, spec.namespace, and the connection namespace and authNamespace |
| self-init | starting without a root token at runtime (self-init guide) |
sys/workflows |
the Workflow kind |
| external plugins | the external-plugin kinds; without the plugin they report Unsupported |
Kubernetes¶
- The chart requires Kubernetes 1.31 or later: CRD validation rules use the CEL IP and CIDR library, which the API server accepts in new CRD expressions only from 1.31.
- Tests run on the envtest version that matches
k8s.io/apiingo.mod(1.35) and on kind in the e2e workflow. - The project supports the Kubernetes minors that are supported upstream when an operator minor is
released, and raises the chart's
kubeVersiononly in a minor release, with a release note. - No admission webhooks are installed, so no cert-manager is needed (ADR 0005).
- All CRDs are
v1alpha1; versions change additively without a conversion webhook (ADR 0020).
Helm and install methods¶
| method | artefact |
|---|---|
| Helm, OCI | oci://ghcr.io/alexandrust88/charts/openbao-config-operator, version 0.5.0 |
| Helm repository | https://alexandrust88.github.io/openbao-config-operator/charts, for tools without OCI support |
| plain manifests | install.yaml and crds.yaml attached to the GitHub release v0.5.0 |
The chart ships the CRDs as templates, so helm upgrade upgrades them; crds.keep (default true)
annotates them with helm.sh/resource-policy: keep. Since v0.3.0 the chart is also signed with the project's GPG
key (Helm provenance), so helm install --verify works; v0.2.0 and earlier have no provenance file. The
install guide has the commands.
Image¶
| property | value |
|---|---|
| registry | ghcr.io/alexandrust88/openbao-config-operator |
| platforms | linux/amd64, linux/arm64 (one multi-arch index) |
| base | gcr.io/distroless/static:nonroot, user 65532 |
| reference | by version tag; the released chart pins the image by digest |
| signing | keyless cosign, with an SBOM attestation and build provenance |
Kind availability classes¶
Each kind in the kind catalogue has an availability class.
| class | meaning | default | tested |
|---|---|---|---|
builtin |
the object is compiled into OpenBao 2.7 (core or the built-in plugin registry) | enabled | unit and integration suites plus the live kit; server prerequisites vary by kind (for example, RaftAutopilot requires raft storage). See the catalogue for evidence and exceptions |
external-plugin |
needs a plugin from openbao-plugins or a third party, registered with Plugin |
disabled: the controllers run only with --enable-plugin-kinds (chart pluginKinds.enabled: true), and the chart installs their CRDs only then |
unit tests and recorded payloads; the optional LDAP lab exercises its plugin/auth configuration, not every plugin kind or backend |
An external-plugin kind reports Unsupported until its plugin is mounted. Only the LDAP, Kerberos
and RADIUS paths are confirmed by OpenBao documentation; the catalogue marks the others (u).
The 52 external-plugin kinds are experimental: there is no complete live matrix for them, so the support statements on this page do not cover them. The LDAP lab provides targeted evidence only; it does not establish support for other plugins or all their typed fields. The typed share in API coverage for OpenBao 2.7.2 contains no plugin-kind path; the 2.6 figure counts LDAP, Kerberos and RADIUS paths, which 2.6 still builds in, through plugin kinds that are not run against a server.