Connection resources · Kind catalogue · Examples
OpenBaoEndpoint¶
API version: core.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: openbaoendpoints.core.openbaoconfig.io
Categories: openbao
OpenBaoEndpoint writes any JSON payload to any OpenBao API path and keeps it in sync: the escape hatch for settings without a typed kind. Prefer a typed kind when one exists; it adds validation, references and exact drift handling. The default deletionPolicy Orphan leaves the path in place; Delete removes path (or deletePath).
Example:
Example:
spec:
connectionRef:
name: openbao
path: auth/userpass/users/alice
data:
token_policies: ["default"]
dataSecretRef:
name: alice-password
key: payload.jsonExample¶
examples/core/openbaoendpoint.yaml
# Manages any OpenBao path the typed kinds do not cover; here a KV v2 secrets engine mount.
# OpenBaoEndpoint is destructive: path and deletePath are free-form, so deletionPolicy Delete takes effect only
# with the annotation openbaoconfig.io/allow-destructive-delete: "true" (otherwise reason DeleteGuarded).
apiVersion: core.openbaoconfig.io/v1alpha1
kind: OpenBaoEndpoint
metadata:
name: team-kv
namespace: openbao-config
annotations:
openbaoconfig.io/allow-destructive-delete: "true"
spec:
connectionRef:
name: openbao
path: sys/mounts/team-kv
readPath: sys/mounts/team-kv/tune
deletionPolicy: Delete
data:
type: kv
options:
version: "2"
On GitHub: openbaoendpoint.yaml, generated sample with every field.
Fields¶
Defaults below are CRD schema defaults. A blank cell does not imply zero, false or an empty value; see the field description for omission behaviour. Required fields inside an optional object apply only when that object is set.
| Field | Type | Required | Default | Description | Validation |
|---|---|---|---|---|---|
spec | object | yes | Desired state: the OpenBao path and the payload to keep there. | ConstraintsCEL:self.path == oldSelf.path (path is immutable)CEL: has(self.data) || has(self.dataSecretRef) (data or dataSecretRef is required)CEL: has(self.__namespace__) == has(oldSelf.__namespace__) && (!has(self.__namespace__) || self.__namespace__ == oldSelf.__namespace__) (namespace is immutable)CEL: self.connectionRef == oldSelf.connectionRef (connectionRef is immutable) | |
spec.connectionRef | object | yes | Connection used to reach and log in to OpenBao. Immutable. | ||
spec.connectionRef.kind | string | no | "OpenBaoConnection" | Kind of the connection: OpenBaoConnection (in the same Kubernetes namespace as this resource) or ClusterOpenBaoConnection (cluster-scoped; its allowedNamespaces must select this namespace). Default: OpenBaoConnection. | Constraintsone of:OpenBaoConnection, ClusterOpenBaoConnection |
spec.connectionRef.name | string | yes | Name of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao | Constraintslength: >=1, <=253 | |
spec.creationPolicy | string | no | "Create" | How an object that already exists in OpenBao, and is not yet owned by this resource, is treated. Create (default): create the object; an existing one is refused with reason Conflict. Adopt: take over an existing object and never create one. CreateOrAdopt: create it, or take over an existing one. Settings that always exist in OpenBao (configuration singletons) need Adopt or CreateOrAdopt. | Constraintsone of:Create, Adopt, CreateOrAdopt |
spec.data | object (any fields) | no | JSON object written to path, with the API's own parameter names. Only its keys are compared with the read; a key removed from data is not unset in OpenBao. Put secret values in dataSecretRef instead. Example: {"token_policies": ["default"], "token_ttl": "1h"} | ||
spec.dataSecretRef | object | no | Secret key holding a JSON object merged over data, for secret parameters such as passwords. Its keys are write-only: never compared with the read, tracked by status.writeOnlyHash, and re-sent when the Secret changes. Read from a Secret key; never stored in status. One of data and dataSecretRef is required. | ||
spec.dataSecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.dataSecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.deletePath | string | no | Path deleted when the resource is deleted with deletionPolicy Delete. Default: path. Example: sys/auth/userpass | Constraintspattern:^[^/].*$ | |
spec.deletionPolicy | string | no | "Orphan" | What happens in OpenBao when this resource is deleted. Orphan (default): the OpenBao object stays. Delete: the object is removed (a configuration singleton is reset to its defaults); data and key holders (mounts, namespaces, KV data, audit devices, endpoints, transit, PKI, SSH CA and TOTP keys, MFA methods, entities) are removed only while the resource carries the annotation openbaoconfig.io/allow-destructive-delete: "true". Kinds whose OpenBao object cannot be deleted reject Delete. | Constraintsone of:Delete, Orphan |
spec.disableDelete | boolean | no | When true, nothing is deleted in OpenBao when the resource is deleted, even with deletionPolicy Delete. For endpoints without a delete. Default: false. | ||
spec.disableRead | boolean | no | When true, the path is never read back: the payload is written on create and whenever the spec or the referenced Secret changes, and drift is not detected. For endpoints without a read. Default: false. | ||
spec.driftDetection | string | no | "Enabled" | Whether OpenBao is re-read periodically to detect and repair out-of-band changes. Enabled (default): re-read every driftInterval. Disabled: write only when the spec or a referenced Secret changes. | Constraintsone of:Enabled, Disabled |
spec.driftInterval | string | no | How often OpenBao is re-read for drift, as a duration of at least 30s. Default: the operator's interval for the kind (15m for kinds that grant access such as policies, auth mounts and roles, 1h for the rest), with jitter. Example: 30m | Constraintslength: <=32CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s) | |
spec.ignoreAbsentFields | boolean | no | When true, keys of data missing from the read response count as in sync instead of as drift. Default: false. | ||
spec.managementPolicy | string | no | "Manage" | Whether the operator writes to OpenBao. Manage (default): converge OpenBao to the spec, create and delete as the policies say. Observe: only read the object and report drift in the conditions; never write or delete. | Constraintsone of:Manage, Observe |
spec.namespace | string | no | OpenBao namespace of the object, relative to the connection's base namespace; empty means the connection namespace itself. Segments are separated by "/", without leading or trailing slash. Immutable: it cannot be added, changed or removed after creation. Example: team-a/apps | Constraintspattern:^[A-Za-z0-9_-][A-Za-z0-9._-]*(/[A-Za-z0-9_-][A-Za-z0-9._-]*)*$length: <=256 | |
spec.path | string | yes | OpenBao API path the payload is written to (POST /v1/<path>), relative to the OpenBao namespace, without a leading slash or the v1/ prefix. Immutable. Example: auth/userpass/users/alice | Constraintspattern:^[^/].*$length: >=1 | |
spec.readPath | string | no | Path read back to compare against data, for endpoints whose read lives elsewhere. Default: path. Example: sys/auth/userpass/tune | Constraintspattern:^[^/].*$ | |
spec.writeOnlyFields | []string | no | Keys of data that a read does not return (write-only API parameters); they are sent but never compared, so they cause no endless rewrite. Example: ["password"] | Constraintslist type: set | |
status | object | no | Observed state reported by the operator: conditions, the written path and namespace, and ownership. | ||
status.acquired | string | no | How the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned. | ||
status.conditions | []object | no | Current state as conditions: Ready (the OpenBao object matches the spec) and Synced (the last reconcile succeeded), each with a reason such as Available, Drifted, Conflict, ConnectionNotReady or PermissionDenied, and the generation it describes. | Constraintslist type: map (keys: type) | |
status.conditions[] | object | no | Condition contains details for one aspect of the current state of this API Resource. | ||
status.conditions[].lastTransitionTime | string (date-time) | yes | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. | ||
status.conditions[].message | string | yes | message is a human readable message indicating details about the transition. This may be an empty string. | Constraintslength: <=32768 | |
status.conditions[].observedGeneration | integer (int64) | no | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. | Constraintsvalue: >=0 | |
status.conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. | Constraintspattern:^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$length: >=1, <=1024 | |
status.conditions[].status | string | yes | status of the condition, one of True, False, Unknown. | Constraintsone of:True, False, Unknown | |
status.conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. | Constraintspattern:^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$length: <=316 | |
status.id | string | no | Identifier OpenBao generated for the object (an entity, group or alias ID, or a mount accessor), for kinds that have one; other resources reference it. Example: 6c9f3e0a-1b2c-4d5e-8f90-123456789abc | ||
status.namespace | string | no | Absolute OpenBao namespace the object was written in; empty means the root namespace. If it later differs from the spec, reconciling stops with reason NamespaceChanged. Example: team-a/apps | ||
status.observedGeneration | integer (int64) | no | The metadata.generation of this resource that the operator last reconciled. | ||
status.path | string | no | Full OpenBao API path of the object, including its namespace, as last written; deletion uses it even after the spec changed. Example: team-a/sys/policies/acl/app-read | ||
status.rotationNonce | string | no | Value of the resource's rotation nonce when one-time inputs, such as a root credential that OpenBao rotates afterwards, were last sent; changing the nonce in the spec sends them again. | ||
status.serverID | string | no | Cluster ID of the OpenBao server the object was acquired on. If the connection later reaches another server, reconciling stops with reason ServerChanged and nothing is written or deleted. Example: 80f7de92-c12e-e960-4754-255c32fc6b53 | ||
status.writeOnlyHash | string | no | Keyed hash (HMAC-SHA256) of the write-only inputs, such as passwords read from Secrets; a change forces a write. It never contains or reveals the values. |