Skip to content

Kind catalogue

Every typed kind, with links to its fields, YAML examples and test evidence. The design is in the architecture. Built-in kinds are implemented; their evidence identifies the tests and runtime each kind needs. A dev server alone cannot exercise cluster-specific features such as raft autopilot. The remaining built-in gaps are in BL-009. The external-plugin kinds stay in the code but are disabled by default behind --enable-plugin-kinds (chart pluginKinds.enabled) until plugin support (phase 5) works end to end.

Plugin kinds are experimental

The 52 external-plugin kinds are experimental. They are not run against a server, and their paths marked (u) come from documentation, not OpenBao source. No coverage claim counts on them: the API coverage share for OpenBao 2.7.2, the figure this documentation cites, contains no plugin-kind path.

Counts: 126 rows, one per CRD in config/crd/bases: 74 built-in kinds, all integration-tested, and 52 plugin-gated kinds (the CRDs listed in hack/chart/plugin-crds.txt). The built-in kinds are OpenBaoServer, the two connection kinds, OpenBaoEndpoint and 70 typed OpenBao kinds. test/apidocs/kinds_catalogue_test.go checks these counts and the evidence paths. Features without a typed kind are listed under not typed.

The API group domain openbaoconfig.io is final (ADR 0008).

Destructive kinds delete only with the annotation openbaoconfig.io/allow-destructive-delete: "true" (ADR 0013): SecretsMount, AuthMount, OpenBaoNamespace, KVSecret, RandomSecret, Audit, OpenBaoEndpoint, TransitKey, PKIIssuer, PKIKey, SSHCA, TOTPKey, MFAMethod, Entity and KVSecretMetadata.

Columns

  • kind: links to the complete API reference; example opens the YAML gallery for that kind.
  • group: the section; the full group is <group>.openbaoconfig.io.
  • path: OpenBao API path, relative to the resource's OpenBao namespace. <m> is a secrets mount path, <b> an auth mount path. (u) marks a path not yet confirmed in OpenBao source.
  • availability:
  • builtin: compiled into OpenBao 2.7 (internal/helper/builtinplugins/registry.go or core).
  • external-plugin: needs a plugin from openbao-plugins (or a third party) registered with Plugin. Only LDAP, Kerberos and RADIUS are confirmed by OpenBao docs; the rest are (u). The kind reports Unsupported until the plugin is mounted.
  • phase: the roadmap phase whose exit test covers the kind; the roadmap defines the phases and their releases. after 6: plugin kinds outside the core plan; they stay gated until each has a plugin and backend in CI.
  • status:
  • implemented: types, adapter, unit and envtest tests; wired in cmd/controllers.go.
  • integration-tested: implemented, and reconciled against a real bao server -dev in the file named under evidence.
  • plugin-gated: experimental; implemented with unit tests and recorded reads, but not tested against a server, because OpenBao 2.7.2 does not ship the plugin; disabled by default.
  • in progress: being implemented now; not in the code yet.
  • planned: a later phase.
  • evidence: test files under test/integration/ (build tag integration), other bao-backed tests by full path, and live when the kind ran Ready on a live OpenBao 2.7.2 cluster (create, update, steady state with zero rewrites, and delete where Delete is allowed).
  • namespace scope (in notes): every built-in kind works in the root and in any child namespace unless its notes say otherwise; root-only kinds are refused with RootOnlyKind before any OpenBao call. Measured per kind and connection mode by test/nsmatrix (architecture).

The engine applies the path index, the destructive guard and the drift tiers to every kind. Every built-in adapter returns its full payload with declared defaults, and the no-write and default conformance tests measure each built-in kind, except the cases in test/conformance/exceptions.yaml (not yet enforced). Write-only fields (absent from reads) are hashed into status.writeOnlyHash (HMAC), never compared.

core

kind path availability phase status evidence notes
OpenBaoServer · example none (holds address, CA bundle, allowed namespaces and audiences, rate limit) builtin 1 integration-tested internal/controller/core/server_bao_test.go, test/e2e cluster-scoped, platform-owned; connections name it with serverRef (ADR 0010)
OpenBaoConnection · example login: auth/<b>/login; status: sys/health, sys/seal-status, auth/token/lookup-self builtin 1 integration-tested internal/openbao/integration_test.go, internal/controller/core/connection_bao_test.go, live namespaced; Kubernetes/JWT auth uses TokenRequest for a ServiceAccount in the same namespace
ClusterOpenBaoConnection · example same builtin 1 integration-tested internal/openbao/integration_test.go, internal/controller/core/connection_bao_test.go cluster-scoped; allowedNamespaces selector
OpenBaoEndpoint · example any builtin 1 integration-tested integration_test.go, live escape hatch, see ADR 0006; destructive (ADR 0013)

sys

kind path availability phase status evidence notes
Policy · example sys/policies/acl/<name> builtin 1 integration-tested integration_test.go, sys_core_test.go, templated_acl_test.go, live ACL only; OpenBao has no EGP/RGP
PasswordPolicy · example sys/policies/password/<name> builtin 4 integration-tested sys_core_test.go, live
OpenBaoNamespace · example sys/namespaces/<path> builtin 2 integration-tested sys_core_test.go, templated_acl_test.go, live namespace scope: any (creates a child of its OpenBao namespace); delete leaves it tainted until purged (ReconcileInProgress); namespace sealing is not supported yet; default Orphan; destructive (ADR 0013)
AuthMount · example sys/auth/<path>, sys/auth/<path>/tune builtin 2 integration-tested identity_test.go, sys_core_test.go, templated_acl_test.go, live type, local, seal_wrap immutable; accessor in status; default Orphan; destructive (ADR 0013)
SecretsMount · example sys/mounts/<path>, sys/mounts/<path>/tune builtin 2 integration-tested sys_core_test.go, templated_acl_test.go, live as AuthMount; destructive (ADR 0013)
Audit · example sys/audit/<path> builtin 4 integration-tested sys_audit_test.go namespace scope: root only (RootOnlyKind elsewhere); types file, socket, syslog, http; destructive (ADR 0013)
AuditRequestHeader · example sys/config/auditing/request-headers/<name> builtin 4 integration-tested sys_config_test.go namespace scope: root only (RootOnlyKind elsewhere); hmac flag
RateLimitQuota · example sys/quotas/rate-limit/<name> builtin 4 integration-tested sys_core_test.go namespace scope: root only (RootOnlyKind elsewhere); enforced per node; group_by and secondary_rate are not in OpenBao
QuotaConfig · example sys/quotas/config builtin 4 integration-tested sys_config_test.go namespace scope: root only (RootOnlyKind elsewhere); singleton
Plugin · example sys/plugins/catalog/<auth\|database\|secret>/<name> builtin 5 integration-tested sys_config_test.go namespace scope: root only (RootOnlyKind elsewhere)
CORSConfig · example sys/config/cors builtin 4 integration-tested sys_config_test.go namespace scope: root only (RootOnlyKind elsewhere); singleton
UIHeader · example sys/config/ui/headers/<name> builtin 4 integration-tested sys_config_test.go namespace scope: root only (RootOnlyKind elsewhere)
Logger · example sys/loggers/<name> builtin 4 integration-tested sys_config_test.go namespace scope: root only (RootOnlyKind elsewhere); runtime log level; not persisted across a server restart (u), so drift repair re-applies it
KeyRotationConfig · example sys/rotate/config builtin 4 integration-tested sys_config_test.go namespace scope: root or a sealable namespace (Unsupported elsewhere); singleton; barrier key rotation, not secret rotation
RaftAutopilot · example sys/storage/raft/autopilot/configuration builtin 4 integration-tested sys_config_test.go namespace scope: root only (RootOnlyKind elsewhere); singleton; raft storage only
Workflow · example sys/workflows/manage/<path> builtin 4 integration-tested sys_config_test.go, live namespace scope: any; OpenBao only (profiles, 2.6+); extra

auth

kind path availability phase status evidence notes
KubernetesAuthConfig · example auth/<b>/config builtin 2 integration-tested auth_builtin_test.go, templated_acl_test.go, live token_reviewer_jwt write-only (read returns token_reviewer_jwt_set)
KubernetesAuthRole · example auth/<b>/role/<name> builtin 2 integration-tested auth_builtin_test.go, templated_acl_test.go, live
JWTAuthConfig · example auth/<b>/config builtin 2 integration-tested auth_builtin_test.go, live oidc_client_secret write-only; sensitive provider_config keys stripped on read
JWTAuthRole · example auth/<b>/role/<name> builtin 2 integration-tested auth_builtin_test.go, live
JWTCELRole · example auth/<b>/cel/role/<name> builtin 4 integration-tested auth_builtin_test.go, live OpenBao only; cel_program kept as opaque text; extra
AppRole · example auth/<b>/role/<name> (+ role/<name>/role-id) builtin 2 integration-tested auth_credentials_test.go, live local_secret_ids create-only
AppRoleSecretID · example auth/<b>/role/<name>/secret-id builtin 2 integration-tested auth_credentials_test.go, live generated secret_id returned once, written via writeSecretRef; create-only
TokenRole · example auth/token/roles/<name> builtin 2 integration-tested auth_credentials_test.go, live
CertAuthConfig · example auth/<b>/config builtin 7 integration-tested auth_credentials_test.go, live
CertAuthRole · example auth/<b>/certs/<name> builtin 7 integration-tested auth_credentials_test.go, live
CertAuthCRL · example auth/<b>/crls/<name> builtin 7 integration-tested secrets_gaps_test.go, live exactly one of crl (write-only PEM) or url; a missing CRL is HTTP 400
UserpassUser · example auth/<b>/users/<name> builtin 7 integration-tested auth_credentials_test.go, live password write-only, from a Secret ref
LDAPAuthConfig · example auth/<b>/config external-plugin 6 plugin-gated - bindpass write-only (u)
LDAPAuthGroup · example auth/<b>/groups/<name> external-plugin 6 plugin-gated -
LDAPAuthUser · example auth/<b>/users/<name> external-plugin 6 plugin-gated -
KerberosAuthConfig · example auth/<b>/config external-plugin 6 plugin-gated - keytab write-only (u)
KerberosAuthLDAPConfig · example auth/<b>/config/ldap external-plugin 6 plugin-gated -
KerberosAuthGroup · example auth/<b>/groups/<name> external-plugin 6 plugin-gated -
RADIUSAuthConfig · example auth/<b>/config external-plugin 6 plugin-gated - shared secret write-only (u)
RADIUSAuthUser · example auth/<b>/users/<name> external-plugin 6 plugin-gated -
AWSAuthConfig · example auth/<b>/config/client external-plugin (u) after 6 plugin-gated - secret key write-only
AWSAuthIdentityConfig · example auth/<b>/config/identity external-plugin (u) after 6 plugin-gated - singleton
AWSAuthRole · example auth/<b>/role/<name> external-plugin (u) after 6 plugin-gated - auth_type immutable
AWSAuthCertificate · example auth/<b>/config/certificate/<name> external-plugin (u) after 6 plugin-gated -
AWSAuthSTSRole · example auth/<b>/config/sts/<account> external-plugin (u) after 6 plugin-gated -
AWSAuthTidyConfig · example auth/<b>/config/tidy/identity-whitelist, .../roletag-blacklist (u) external-plugin (u) after 6 plugin-gated - one kind, two singletons
AzureAuthConfig · example auth/<b>/config external-plugin (u) after 6 plugin-gated - client secret write-only
AzureAuthRole · example auth/<b>/role/<name> external-plugin (u) after 6 plugin-gated -
GCPAuthConfig · example auth/<b>/config external-plugin (u) after 6 plugin-gated - credentials write-only
GCPAuthRole · example auth/<b>/role/<name> external-plugin (u) after 6 plugin-gated - type immutable
GitHubAuthConfig · example auth/<b>/config external-plugin (u) after 6 plugin-gated -
GitHubAuthTeam · example auth/<b>/map/teams/<team> external-plugin (u) after 6 plugin-gated -
GitHubAuthUser · example auth/<b>/map/users/<user> external-plugin (u) after 6 plugin-gated -
OktaAuthConfig · example auth/<b>/config external-plugin (u) after 6 plugin-gated - API token write-only
OktaAuthGroup · example auth/<b>/groups/<name> external-plugin (u) after 6 plugin-gated -
OktaAuthUser · example auth/<b>/users/<name> external-plugin (u) after 6 plugin-gated -
OCIAuthConfig · example auth/<b>/config external-plugin (u) after 6 plugin-gated -
OCIAuthRole · example auth/<b>/role/<name> external-plugin (u) after 6 plugin-gated -
CFAuthConfig · example auth/<b>/config external-plugin (u) after 6 plugin-gated - Cloud Foundry
CFAuthRole · example auth/<b>/roles/<name> external-plugin (u) after 6 plugin-gated -

secrets

kind path availability phase status evidence notes
KVSecret · example v2: <m>/data/<path> (+ <m>/metadata/<path>); v1: <m>/<path> builtin 4 integration-tested secrets_kv_test.go, live values from Secret refs; bounded version destruction retaining metadata (Deleter); default Orphan; destructive (ADR 0013)
KVConfig · example <m>/config builtin 4 integration-tested secrets_kv_test.go, live singleton per mount: max_versions, cas_required, delete_version_after
KVSecretMetadata · example <m>/metadata/<path> builtin 4 integration-tested secrets_gaps_test.go, live per-secret retention and custom_metadata; an omitted field is left stored, and a set map replaces the stored keys; delete removes every version, so it is destructive (ADR 0013)
RandomSecret · example <m>/data/<path>; value from sys/policies/password/<name>/generate builtin 4 integration-tested secrets_kv_test.go, live OpenBao generates the value from the password policy; destructive (ADR 0013)
DatabaseConnection · example <m>/config/<name> builtin 4 integration-tested secrets_credentials_test.go, live password, private_key write-only; connection_url redacted on read; never re-send the password after rotate-root; builtin plugins: MySQL family, PostgreSQL, Cassandra, InfluxDB, Redis, Valkey
DatabaseRole · example <m>/roles/<name> builtin 4 integration-tested secrets_credentials_test.go, live
DatabaseStaticRole · example <m>/static-roles/<name> builtin 4 integration-tested secrets_credentials_test.go password not returned
PKIIssuer · example generate: <m>/root/generate/<type>, <m>/intermediate/generate/<type>; import: <m>/config/ca, <m>/intermediate/set-signed; config: <m>/issuer/<ref> builtin 4 integration-tested secrets_pki_test.go, live multi-step and non-idempotent; exported private key returned once (writeSecretRef); CSR in status; destructive (ADR 0013)
PKIKey · example <m>/key/<ref>, <m>/keys/generate/<type>, <m>/keys/import builtin 4 integration-tested secrets_pki_test.go, live extra; OpenBao external keys (sys/external-keys) are an alternative; destructive (ADR 0013)
PKIRole · example <m>/roles/<name> builtin 4 integration-tested secrets_pki_test.go, live
PKICELRole · example <m>/cel/roles/<name> builtin 4 integration-tested secrets_gaps_test.go, live cel_program is the expression and its variables
PKIKeyConfig · example <m>/config/keys builtin 4 integration-tested secrets_gaps_test.go, live singleton; default may be a key name, which OpenBao stores as the key id; the name default is reserved; no delete, so deletionPolicy is Orphan
PKIConfig · example <m>/config/urls, <m>/config/crl, <m>/config/cluster, <m>/config/issuers builtin 4 integration-tested secrets_pki_test.go, live one kind for the per-mount singletons
PKIACMEConfig · example <m>/config/acme builtin (u) 4 integration-tested secrets_pki_test.go, live
PKIAutoTidy · example <m>/config/auto-tidy builtin 4 integration-tested secrets_pki_test.go, live extra
TransitKey · example <m>/keys/<name>, <m>/keys/<name>/config builtin 4 integration-tested secrets_engines_test.go, live type, derived, convergent_encryption immutable; key material never read; delete needs deletion_allowed; destructive (ADR 0013)
TransitCacheConfig · example <m>/cache-config builtin 4 integration-tested secrets_gaps_test.go, live singleton; size is 0 or at least 10; 0 is an unlimited cache; no delete, so deletionPolicy is Orphan
TransitKeyConfig · example <m>/config/keys builtin 4 integration-tested secrets_gaps_test.go, live singleton; disable_upsert; no delete, so deletionPolicy is Orphan
SSHCA · example <m>/config/ca builtin 4 integration-tested secrets_engines_test.go, live private_key write-only (u); generated key cannot be replaced without delete; destructive (ADR 0013)
SSHRole · example <m>/roles/<name> builtin 4 integration-tested secrets_engines_test.go, live
KubernetesSecretsConfig · example <m>/config builtin 2 integration-tested secrets_credentials_test.go, live service_account_jwt write-only
KubernetesSecretsRole · example <m>/roles/<name> builtin 2 integration-tested secrets_credentials_test.go, live
RabbitMQConfig · example <m>/config/connection, <m>/config/lease builtin 6 integration-tested secrets_credentials_test.go, live password write-only; two writes (Writer); built into 2.7.2; listed under phase 6 pending an open question
RabbitMQRole · example <m>/roles/<name> builtin 6 integration-tested secrets_credentials_test.go, live
TOTPKey · example <m>/keys/<name> builtin 4 integration-tested secrets_engines_test.go, live with generate=true the barcode and URL are returned once; destructive (ADR 0013)
LDAPSecretsConfig · example <m>/config external-plugin 6 plugin-gated - bindpass write-only
LDAPSecretsDynamicRole · example <m>/role/<name> external-plugin 6 plugin-gated -
LDAPSecretsStaticRole · example <m>/static-role/<name> external-plugin 6 plugin-gated -
AWSSecretsConfig · example <m>/config/root, <m>/config/lease external-plugin (u) after 6 plugin-gated - secret key write-only
AWSSecretsRole · example <m>/roles/<name> external-plugin (u) after 6 plugin-gated -
AzureSecretsConfig · example <m>/config external-plugin (u) after 6 plugin-gated -
AzureSecretsRole · example <m>/roles/<name> external-plugin (u) after 6 plugin-gated -
GCPSecretsConfig · example <m>/config external-plugin (u) after 6 plugin-gated -
GCPRoleset · example <m>/roleset/<name> external-plugin (u) after 6 plugin-gated -
GCPStaticAccount · example <m>/static-account/<name> external-plugin (u) after 6 plugin-gated -
GCPImpersonatedAccount · example <m>/impersonated-account/<name> external-plugin (u) after 6 plugin-gated -
ConsulSecretsConfig · example <m>/config/access external-plugin (u) after 6 plugin-gated -
ConsulSecretsRole · example <m>/roles/<name> external-plugin (u) after 6 plugin-gated -
NomadSecretsConfig · example <m>/config/access, <m>/config/lease external-plugin (u) after 6 plugin-gated -
NomadSecretsRole · example <m>/role/<name> external-plugin (u) after 6 plugin-gated -
TerraformCloudSecretsConfig · example <m>/config external-plugin (u) after 6 plugin-gated -
TerraformCloudSecretsRole · example <m>/role/<name> external-plugin (u) after 6 plugin-gated -
MongoDBAtlasSecretsConfig · example <m>/config external-plugin (u) after 6 plugin-gated -
MongoDBAtlasSecretsRole · example <m>/roles/<name> external-plugin (u) after 6 plugin-gated -
GitHubSecretsConfig · example <m>/config external-plugin (u) after 6 plugin-gated - third-party plugin; app private key write-only
GitHubSecretsRole · example <m>/permissionset/<name> external-plugin (u) after 6 plugin-gated - third-party plugin
QuaySecretsConfig · example <m>/config external-plugin (u) after 6 plugin-gated - third-party plugin
QuaySecretsRole · example <m>/roles/<name> external-plugin (u) after 6 plugin-gated - third-party plugin
QuaySecretsStaticRole · example <m>/static-roles/<name> external-plugin (u) after 6 plugin-gated - third-party plugin

identity

kind path availability phase status evidence notes
Entity · example identity/entity/name/<name> builtin 3 integration-tested identity_test.go, templated_acl_test.go, live ID server-generated, kept in status.id; default Orphan; destructive (ADR 0013)
EntityAlias · example identity/entity-alias/id/<id> builtin 3 integration-tested identity_test.go, templated_acl_test.go, live no lookup by name; identity is (mount accessor, name), adopt by list and read
Group · example identity/group/name/<name> builtin 3 integration-tested identity_test.go, templated_acl_test.go, live type internal/external immutable; default Orphan
GroupAlias · example identity/group-alias/id/<id> builtin 3 integration-tested identity_test.go, live external groups only
GroupMembership · example identity/group/id/<id> (member_entity_ids, member_group_ids) builtin 3 integration-tested identity_test.go, templated_acl_test.go, live no endpoint of its own: read-modify-write of the group, removing only members it added
OIDCConfig · example identity/oidc/config builtin 4 integration-tested identity_oidc_test.go, live singleton (issuer)
OIDCKey · example identity/oidc/key/<name> builtin 4 integration-tested identity_oidc_test.go, live
OIDCRole · example identity/oidc/role/<name> builtin 4 integration-tested identity_oidc_test.go, live
OIDCProvider · example identity/oidc/provider/<name> builtin 4 integration-tested identity_oidc_test.go, live
OIDCClient · example identity/oidc/client/<name> builtin 4 integration-tested identity_oidc_test.go, live client_id, client_secret server-generated; secret written via writeSecretRef
OIDCScope · example identity/oidc/scope/<name> builtin 4 integration-tested identity_oidc_test.go, live
OIDCAssignment · example identity/oidc/assignment/<name> builtin 4 integration-tested identity_oidc_test.go, live
MFAMethod · example identity/mfa/method/<totp\|okta\|duo\|pingid>/<id> builtin 4 integration-tested identity_oidc_test.go, live destructive (ADR 0013)
MFALoginEnforcement · example identity/mfa/login-enforcement/<name> builtin 4 integration-tested identity_oidc_test.go, live

access

kind path availability phase status evidence notes
AccessLevel · example none (cited by grants and layouts) builtin 7 integration-tested access_test.go, templated_acl_test.go, live in-use finalizer
AccessGrant · example sys/policies/acl/<name>, auth/<b>/role/<name> builtin 7 integration-tested access_test.go, templated_acl_test.go, live one Kubernetes auth role per subject
AccessLayout · example sys/policies/acl/<name>, identity/group/name/<name>, identity/group-alias builtin 7 integration-tested access_test.go, live

Not typed

These features have no typed kind: OpenBao does not have them, or they are actions rather than configuration (ADR 0009).

feature availability why not typed reach it with
Sentinel EGP and RGP policies not-in-openbao OpenBao has ACL policies only -
KMIP secrets engine not-in-openbao no KMIP engine in OpenBao -
Transform secrets engine not-in-openbao no Transform engine in OpenBao -
managed keys not-in-openbao OpenBao has sys/external-keys instead, with a different API OpenBaoEndpoint; a typed external-keys kind may follow
legacy step-up MFA (sys/mfa/method/...) not-in-openbao login MFA covers it MFAMethod
lease count quotas not-in-openbao OpenBao has rate-limit quotas only -
raft snapshot agent configuration not-in-openbao OpenBao uses a separate snapshot agent -
secret rotation policies (sys/policies/rotation/<name>) not-in-openbao (u) no secret rotation manager in OpenBao -
container plugin runtimes not-in-openbao (u) not found in OpenBao OpenBaoEndpoint
pinned plugin versions not-in-openbao (u) OpenBao 2.7 pins plugins differently; to verify OpenBaoEndpoint
Active Directory secrets engine not-in-openbao deprecated upstream; the LDAP engine replaces it LDAPSecretsConfig
AliCloud auth not-in-openbao (u) not built in; no OpenBao plugin confirmed OpenBaoEndpoint
token creation action-not-config creating a token is an action; a token in a Secret is a credential to rotate, not config TokenRole + workload login
logins (AppRole, AWS) action-not-config a login -
AWS role tags action-not-config creates a role tag value each call -
PKI certificate issuing and signing action-not-config issuing or signing creates a new certificate each time cert-manager with an OpenBao issuer; PKIIssuer for the CA chain
reading dynamic credentials action-not-config each read creates new credentials External Secrets Operator
copying secret values into Kubernetes Secrets builtin out of scope (ADR 0007) External Secrets Operator

Not catalogued

Reachable with OpenBaoEndpoint and candidates for later typed kinds: OpenBao sealable-namespace operations, user lockout config (tune user_lockout_config on AuthMount), plugin reload, control groups, and the namespace API lock.