Secrets engine resources · Kind catalogue · Examples
RandomSecret¶
API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: randomsecrets.secrets.openbaoconfig.io
Categories: openbao
RandomSecret generates a value, such as a password, once and stores it under one key of a KV secret (`<mount>/data/<path>` on version 2). Use it for credentials nobody needs to choose; set writeSecretRef to also get the value in a Kubernetes Secret.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: secret
path: apps/billing/db
key: password
generator:
length: 40Example¶
examples/secrets/randomsecret.yaml
# Generates a session key once, stores it in KV and copies it to a Kubernetes Secret; changing refreshNonce
# regenerates it. The second resource generates a password from a PasswordPolicy instead.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RandomSecret
metadata:
name: obco-app-session-key
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: secret
path: obco/app-random
kvVersion: 2
key: session-key
generator:
length: 48
charset: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_
refreshNonce: "2026-11-14"
writeSecretRef:
name: obco-app-session-key
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RandomSecret
metadata:
name: obco-app-admin-password
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: secret
path: obco/app-admin
kvVersion: 2
key: admin-password
passwordPolicyName: db-passwords
refreshNonce: "1"
writeSecretRef:
name: obco-app-admin-password
On GitHub: randomsecret.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 | spec is the desired generated value, stored under one key of a KV secret. The value is generated once, when the key is absent, and kept afterwards: an existing value is adopted, and changing the generator settings does not regenerate it. Change refreshNonce to generate a new value. Other keys at the same path are kept. | ConstraintsCEL:self.mountPath == oldSelf.mountPath (mountPath is immutable)CEL: self.path == oldSelf.path (path is immutable)CEL: has(self.kvVersion) == has(oldSelf.kvVersion) && (!has(self.kvVersion) || self.kvVersion == oldSelf.kvVersion) (kvVersion is immutable)CEL: has(self.key) == has(oldSelf.key) && (!has(self.key) || self.key == oldSelf.key) (key is immutable)CEL: !(has(self.passwordPolicyName) && has(self.generator)) (set at most one of passwordPolicyName and generator)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.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.generator | object | no | generator describes a value generated by the operator from a cryptographically secure source; used when passwordPolicyName is unset. Read only when a value is generated (on create and when refreshNonce changes): changing or removing it later keeps the stored value and writes nothing. Example: `{length: 40}`. | ||
spec.generator.charset | string | no | "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" | charset lists the characters to draw from; duplicates are ignored. 10-256 characters. Defaults to ASCII letters and digits. Example: `abcdef0123456789`. | Constraintslength: >=10, <=256 |
spec.generator.length | integer (int32) | no | 32 | length is the length of the value in characters. 8-1024. Defaults to 32. | Constraintsvalue: >=8, <=1024 |
spec.key | string | no | "password" | key is the key of the OpenBao secret that holds the generated value. Defaults to `password`. Immutable. Example: `admin-password`. | Constraintspattern:^[-._a-zA-Z0-9]+$length: >=1, <=253 |
spec.kvVersion | integer (int32) | no | 2 | kvVersion is the version of the KV engine at mountPath. Allowed: 1, 2. Defaults to 2. Immutable. | Constraintsone of:1, 2 |
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.mountPath | string | yes | mountPath is the path of the KV secrets engine mount, without leading or trailing slashes. Immutable. Example: `secret`. | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: >=1, <=128 | |
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.passwordPolicyName | string | no | passwordPolicyName generates the value with this OpenBao password policy (`sys/policies/password/<name>/generate`), looked up in the resource's OpenBao namespace. Unset uses generator. Read only when a value is generated (on create and when refreshNonce changes): changing or removing it later keeps the stored value and writes nothing. Example: `strong`. | Constraintslength: >=1, <=128 | |
spec.path | string | yes | path is the secret path inside the mount, without the `data/` prefix of KV version 2 (the operator adds it). Immutable. Example: `apps/billing/db`. | Constraintspattern:^[^/]+(/[^/]+)*$length: >=1, <=512 | |
spec.refreshNonce | string | no | refreshNonce is an arbitrary string; changing it generates a new value. Example: `2026-11-rotation`. | Constraintslength: <=253 | |
spec.writeSecretRef | object | no | writeSecretRef also stores the value under key in this Secret, which the resource then owns. The Secret is written when the value is generated or adopted and when writeSecretRef changes. The value is never stored in status. Example: `{name: db-admin}`. | ||
spec.writeSecretRef.name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
status | object | no | status is the observed state of the random secret (never the value). | ||
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.pathCreated | boolean | no | pathCreated is true when this resource created the KV secret rather than adding its key to an existing one; only then does a destructive delete also remove the secret's version history. | ||
status.purgeThroughVersion | integer (int64) | no | purgeThroughVersion is the persisted upper version bound for destructive KV v2 cleanup. Newer versions and metadata are retained. | Constraintsvalue: >=1 | |
status.refreshNonce | string | no | refreshNonce is the spec.refreshNonce the current value was generated or adopted with. | ||
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. |