Secrets engine resources · Kind catalogue · Examples
TransitKey¶
API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: transitkeys.secrets.openbaoconfig.io
Categories: openbao
TransitKey manages a named key of a transit secrets engine at `<mount>/keys/<name>`, for encryption as a service, signing or HMAC; its key material never leaves OpenBao unless exportable. Change rotateNonce to rotate it once.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: transit
name: orders
type: aes256-gcm96
autoRotatePeriod: 720hExample¶
examples/secrets/transitkey.yaml
# An AES-256-GCM transit key for application encryption that rotates every 30 days, plus an HMAC key.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitKey
metadata:
name: obco-app-encryption
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: transit
name: obco-app
type: aes256-gcm96
derived: true
convergentEncryption: true
exportable: true
allowPlaintextBackup: true
autoRotatePeriod: 720h
minDecryptionVersion: 1
minEncryptionVersion: 0
deletionAllowed: false
rotateNonce: "2026-11-14"
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitKey
metadata:
name: obco-app-hmac
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: transit
type: hmac
keySize: 64
On GitHub: transitkey.yaml, generated sample with every field.
Behaviour and permissions¶
The connection needs access to an existing Transit mount. The operator creates keys at
<mount>/keys/<name> and updates mutable settings at <mount>/keys/<name>/config.
- Irreversible settings: once enabled,
exportableandallowPlaintextBackupcannot be disabled. - Rotation:
autoRotatePeriodschedules rotation in OpenBao; changingrotateNoncerequests one rotation. Rotation creates a new version while preserving older key material. RaisingminDecryptionVersioncan make older ciphertext undecryptable until that limit is lowered. - Deletion:
deletionAllowedenables deletion in OpenBao; it does not request deletion by the operator. Operator deletion also needsdeletionPolicy: Deleteandopenbaoconfig.io/allow-destructive-delete: "true". The defaultOrphanretains the key. Deleting its parent mount or OpenBao namespace still destroys the contained key material. - Status: Ready means the managed configuration matches the current spec. It does not prove an application's token can encrypt or decrypt; verify that with the application's identity.
- Permissions: grant read/create/update on the key paths, and delete only when deletion is
intended. Explicit rotation also needs update on
<mount>/keys/<name>/rotate.
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 named key of a transit secrets engine at `<mountPath>/keys/<name>`. Settings fixed at creation (type, derived, convergentEncryption, keySize, externalKeyRef) are immutable. | ConstraintsCEL:has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)CEL: has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name is immutable)CEL: has(self.type) == has(oldSelf.type) && (!has(self.type) || self.type == oldSelf.type) (type is immutable)CEL: has(self.derived) == has(oldSelf.derived) && (!has(self.derived) || self.derived == oldSelf.derived) (derived is immutable)CEL: has(self.convergentEncryption) == has(oldSelf.convergentEncryption) && (!has(self.convergentEncryption) || self.convergentEncryption == oldSelf.convergentEncryption) (convergentEncryption is immutable)CEL: has(self.keySize) == has(oldSelf.keySize) && (!has(self.keySize) || self.keySize == oldSelf.keySize) (keySize is immutable)CEL: has(self.externalKeyRef) == has(oldSelf.externalKeyRef) && (!has(self.externalKeyRef) || self.externalKeyRef == oldSelf.externalKeyRef) (externalKeyRef is immutable)CEL: !has(oldSelf.exportable) || !oldSelf.exportable || (has(self.exportable) && self.exportable) (exportable cannot be disabled once enabled)CEL: !has(oldSelf.allowPlaintextBackup) || !oldSelf.allowPlaintextBackup || (has(self.allowPlaintextBackup) && self.allowPlaintextBackup) (allowPlaintextBackup cannot be disabled once enabled)CEL: !has(self.convergentEncryption) || !self.convergentEncryption || (has(self.derived) && self.derived) (convergentEncryption requires derived)CEL: !has(self.keySize) || self.type == 'hmac' || self.type == 'external-key' (keySize applies only to hmac and external-key keys)CEL: (self.type == 'external-key') == has(self.externalKeyRef) (externalKeyRef is required for, and only allowed with, type external-key)CEL: !has(self.autoRotatePeriod) || duration(self.autoRotatePeriod) == duration('0s') || (self.type != 'external-key' && duration(self.autoRotatePeriod) >= duration('1h')) (autoRotatePeriod must be 0 or at least 1h, and 0 for external-key keys)CEL: !has(self.minEncryptionVersion) || !has(self.minDecryptionVersion) || self.minEncryptionVersion == 0 || self.minEncryptionVersion >= self.minDecryptionVersion (minEncryptionVersion must be 0 or at least minDecryptionVersion)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.allowPlaintextBackup | boolean | no | allowPlaintextBackup allows a plaintext backup of the key (`allow_plaintext_backup`). Defaults to false. Once enabled it cannot be disabled. | ||
spec.autoRotatePeriod | string | no | autoRotatePeriod rotates the key automatically after this period (`auto_rotate_period`), a duration: 0 disables it, otherwise at least `1h`; must be 0 for external-key. Defaults to 0. Example: `720h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
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.convergentEncryption | boolean | no | convergentEncryption makes the same plaintext, context and nonce produce the same ciphertext (`convergent_encryption`). Requires derived. Defaults to false. Immutable. | ||
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.deletionAllowed | boolean | no | deletionAllowed allows the key to be deleted in OpenBao (`deletion_allowed`). Defaults to false; set automatically before the key is deleted under deletionPolicy Delete. | ||
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.derived | boolean | no | derived enables key derivation, so every request must carry a context (`derived`). Defaults to false. Immutable. | ||
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.exportable | boolean | no | exportable allows every version of the key to be exported (`exportable`). Defaults to false. Once enabled it cannot be disabled. | ||
spec.externalKeyRef | string | no | externalKeyRef names the external key as `<config name>:<key name>` (`external_key_ref`), required for and only allowed with type external-key. Immutable. Example: `hsm:orders-key`. | Constraintslength: <=256 | |
spec.keySize | integer (int32) | no | keySize is the key size in bytes for hmac and external-key keys only (`key_size`). 32-512. Immutable. Example: `32`. | Constraintsvalue: >=32, <=512 | |
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.minDecryptionVersion | integer (int32) | no | minDecryptionVersion is the oldest key version allowed to decrypt or verify (`min_decryption_version`). Minimum 1. Defaults to 1. | Constraintsvalue: >=1 | |
spec.minEncryptionVersion | integer (int32) | no | minEncryptionVersion is the oldest key version allowed to encrypt or sign (`min_encryption_version`); 0 means the latest version. Must be 0 or at least minDecryptionVersion. Defaults to 0. | Constraintsvalue: >=0 | |
spec.mountPath | string | no | "transit" | mountPath is the path of the transit secrets engine mount. Defaults to `transit`. Immutable. Example: `transit`. | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: <=128 |
spec.name | string | no | name is the key name in OpenBao. Defaults to metadata.name. Immutable. Example: `orders`. | Constraintspattern:^[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.rotateNonce | string | no | rotateNonce rotates the key once (`<mountPath>/keys/<name>/rotate`) each time it changes to a new value. The first value seen when the key is created or adopted does not rotate it. Up to 63 characters. Example: `2026-q4`. | Constraintslength: <=63 | |
spec.type | string | no | "aes256-gcm96" | type is the key algorithm (`type`), fixed at creation. Allowed: aes128-gcm96, aes256-gcm96, chacha20-poly1305, xchacha20-poly1305, ecdsa-p256, ecdsa-p384, ecdsa-p521, ed25519, rsa-2048, rsa-3072, rsa-4096, mldsa-44, mldsa-65, mldsa-87, hmac, external-key. Defaults to aes256-gcm96. Immutable. | Constraintsone of:aes128-gcm96, aes256-gcm96, chacha20-poly1305, xchacha20-poly1305, ecdsa-p256, ecdsa-p384, ecdsa-p521, ed25519, rsa-2048, rsa-3072, rsa-4096, mldsa-44, mldsa-65, mldsa-87, hmac, external-key |
status | object | no | status is the observed state of the transit key. | ||
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.latestVersion | integer (int64) | no | latestVersion is the latest version of the key. | ||
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.rotatedNonce | string | no | rotatedNonce is the last spec.rotateNonce that was applied. | ||
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. |