System resources · Kind catalogue · Examples
Audit¶
API version: sys.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: audits.sys.openbaoconfig.io
Categories: openbao
Audit enables an OpenBao audit device at sys/audit/<path>, in the root namespace only; every field is immutable. OpenBao accepts this only when the server configuration sets unsafe_allow_api_audit_creation; otherwise declare the device in the server configuration and use creationPolicy Adopt to assert it exists. The default deletionPolicy Orphan keeps the device; Delete needs the annotation openbaoconfig.io/allow-destructive-delete: "true".
Example:
Example:
spec:
connectionRef:
kind: ClusterOpenBaoConnection
name: openbao
type: file
path: file
options:
file_path: /var/log/openbao/audit.logExample¶
examples/sys/audit.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Audit
metadata:
name: obco-stdout
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Adopt
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 15m
path: stdout
type: file
description: audit log to standard output, declared in the server configuration
local: false
options:
file_path: stdout
---
apiVersion: v1
kind: Secret
metadata:
name: obco-siem-audit
namespace: openbao-config
type: Opaque
stringData:
headers: '{"Authorization":["Bearer fake-siem-token"]}'
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Audit
metadata:
name: obco-siem
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
managementPolicy: Manage
path: siem
type: http
description: audit events forwarded to the SIEM collector
local: true
options:
uri: https://siem-collector.example.com/openbao
format: json
hmac_accessor: "true"
optionsSecretRefs:
headers:
name: obco-siem-audit
key: headers
On GitHub: audit.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 of the audit device. | ConstraintsCEL:!has(self.__namespace__) || self.__namespace__ == '' (Audit exists only in the root namespace: leave namespace empty)CEL: has(self.path) == has(oldSelf.path) && (!has(self.path) || self.path == oldSelf.path) (path is immutable)CEL: self.type == oldSelf.type (type is immutable)CEL: has(self.description) == has(oldSelf.description) && (!has(self.description) || self.description == oldSelf.description) (description is immutable)CEL: has(self.local) == has(oldSelf.local) && (!has(self.local) || self.local == oldSelf.local) (local is immutable)CEL: has(self.options) == has(oldSelf.options) && (!has(self.options) || self.options == oldSelf.options) (options is immutable)CEL: has(self.optionsSecretRefs) == has(oldSelf.optionsSecretRefs) && (!has(self.optionsSecretRefs) || self.optionsSecretRefs == oldSelf.optionsSecretRefs) (optionsSecretRefs is immutable)CEL: !has(self.options) || !has(self.optionsSecretRefs) || self.optionsSecretRefs.all(k, !(k in self.options)) (an option is set in both options and optionsSecretRefs)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.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.description | string | no | Human-readable description of the audit device. Maps to `description`. Immutable. Example: Main file audit log | Constraintslength: <=1024 | |
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.local | boolean | no | Marks the audit device as local to this server cluster. Maps to `local`. Default: false. Immutable. | ||
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.options | map[string]string | no | Device options as string key/value pairs. Maps to `options`; the keys depend on the type, such as file_path, format, hmac_accessor or prefix (prefix needs allow_audit_log_prefixing in the server configuration). Immutable. Example: {"file_path": "/var/log/openbao/audit.log"} | Constraintsproperties: <=32each value: length: <=4096 | |
spec.optionsSecretRefs | map[string]object | no | Device options whose values come from Secret keys, for values that must not appear in the resource, such as the headers of an http device that carry a token. The map key is the option name and must not also be in options. Read from a Secret key; never stored in status. Immutable. Example: {"headers": {"name": "audit-http", "key": "headers"}} | Constraintsproperties: <=8 | |
spec.optionsSecretRefs.<key> | object | no | A key of a Kubernetes Secret in the same namespace as this resource; the value is read at each write and never stored in status. | ||
spec.optionsSecretRefs.<key>.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.optionsSecretRefs.<key>.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.path | string | no | Path the audit device is enabled at, under sys/audit/. Default: metadata.name. Immutable: it cannot be added, changed or removed after creation. Example: file | Constraintspattern:^[A-Za-z0-9_-][A-Za-z0-9._-]*(/[A-Za-z0-9_-][A-Za-z0-9._-]*)*$length: >=1, <=256 | |
spec.type | string | yes | Audit device type. Maps to `type`. Allowed values: file, socket, syslog, http. Immutable. Example: file | Constraintsone of:file, socket, syslog, http | |
status | object | no | Observed state reported by the operator. | ||
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. |