Skip to content

Secrets engine resources · Kind catalogue · Examples

PKIKey

API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: pkikeys.secrets.openbaoconfig.io
Categories: openbao

PKIKey manages a private key of a PKI secrets engine at `<mount>/key/<name>`, generated in OpenBao, backed by an external key, or imported from a Secret. Use it to create a CA key before its issuer, or to keep a key across issuer renewals.

Example:

spec:
  connectionRef:
    name: openbao
  mountPath: pki-int
  name: int-2026
  type: internal
  keyType: ec
  keyBits: 384

Example

examples/secrets/pkikey.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKey
metadata:
  name: obco-int-key
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: obco-pki-int
  name: obco-int-key
  type: internal
  keyType: ec
  keyBits: 256
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKey
metadata:
  name: obco-exported-key
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  mountPath: obco-pki-int
  type: exported
  keyType: rsa
  keyBits: 4096
  writeSecretRef:
    name: obco-exported-key-private
---
apiVersion: v1
kind: Secret
metadata:
  name: obco-imported-key
  namespace: openbao-config
type: Opaque
stringData:
  key.pem: fake-pem-private-key-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKey
metadata:
  name: obco-imported-key
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  mountPath: obco-pki-int
  type: import
  pemBundleSecretRef:
    name: obco-imported-key
    key: key.pem

On GitHub: pkikey.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.

FieldTypeRequiredDefaultDescriptionValidation
specobjectyesspec is the desired private key of a PKI secrets engine, at `<mountPath>/key/<name>`. The key is generated or imported once; afterwards only its name is reconciled. Issuers reference it through PKIIssuer key.existing.
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: self.type == oldSelf.type (type is immutable)
CEL: has(self.keyType) == has(oldSelf.keyType) && (!has(self.keyType) || self.keyType == oldSelf.keyType) (keyType is immutable)
CEL: has(self.keyBits) == has(oldSelf.keyBits) && (!has(self.keyBits) || self.keyBits == oldSelf.keyBits) (keyBits is immutable)
CEL: has(self.externalKeyRef) == has(oldSelf.externalKeyRef) && (!has(self.externalKeyRef) || self.externalKeyRef == oldSelf.externalKeyRef) (externalKeyRef is immutable)
CEL: (self.type == 'internal' || self.type == 'exported') || (!has(self.keyType) && !has(self.keyBits)) (keyType and keyBits apply only to type internal or exported)
CEL: (self.type == 'kms') == has(self.externalKeyRef) (externalKeyRef is required with type kms and allowed only there)
CEL: (self.type == 'import') == has(self.pemBundleSecretRef) (pemBundleSecretRef is required with type import and allowed only there)
CEL: (self.type == 'exported') == has(self.writeSecretRef) (writeSecretRef is required with type exported and allowed only there)
CEL: self.?name.orValue('') != 'default' (default is a reserved key name)
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.connectionRefobjectyesConnection used to reach and log in to OpenBao. Immutable.
spec.connectionRef.kindstringno"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.namestringyesName of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao
Constraintslength: >=1, <=253
spec.creationPolicystringno"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.deletionPolicystringno"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.driftDetectionstringno"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.driftIntervalstringnoHow 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: <=32
CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s)
spec.externalKeyRefstringnoexternalKeyRef is the OpenBao external key used with type kms (`external_key_ref`). Required with kms and allowed only there. Immutable. Example: `hsm-pki-key`.
Constraintslength: >=1, <=512
spec.keyBitsinteger (int32)nokeyBits is the size of a generated key (`key_bits`): 2048, 3072, 4096 or 8192 for rsa; 224, 256, 384 or 521 for ec; 44, 65 or 87 for mldsa; unused for ed25519. Defaults to 2048 for rsa and 256 for ec. Immutable. Example: `384`.
Constraintsone of: 44, 65, 87, 224, 256, 384, 521, 2048, 3072, 4096, 8192
spec.keyTypestringnokeyType is the algorithm of a generated key (`key_type`), type internal or exported only. Defaults to rsa. Immutable. Example: `ec`.
Constraintsone of: rsa, ec, ed25519, mldsa
spec.managementPolicystringno"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.mountPathstringno"pki"mountPath is the path of the PKI secrets engine mount. Defaults to `pki`. Immutable. Example: `pki-int`.
Constraintspattern: ^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$
length: <=128
spec.namestringnoname is the key name in OpenBao (`key_name`). Defaults to metadata.name; `default` is reserved. Immutable. Example: `int-2026`.
Constraintspattern: ^[A-Za-z0-9_]([A-Za-z0-9_.-]*[A-Za-z0-9_])?$
length: >=1, <=128
spec.namespacestringnoOpenBao 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.pemBundleSecretRefobjectnopemBundleSecretRef selects a Secret key holding the PEM private key to import with type import (`pem_bundle`). Read from a Secret key; never stored in status. Sent only when the key is created; keep the Secret while the resource exists. Example: `{name: int-ca-key, key: tls.key}`.
spec.pemBundleSecretRef.keystringyesKey in the Secret's data whose value is used. Example: password
Constraintslength: >=1, <=253
spec.pemBundleSecretRef.namestringyesName of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials
Constraintslength: >=1, <=253
spec.typestringno"internal"type is how the key is created: `internal` (generated, never leaves OpenBao), `exported` (generated and written once to writeSecretRef), `kms` (backed by an OpenBao external key) or `import` (read from pemBundleSecretRef). Defaults to internal. Immutable.
Constraintsone of: internal, exported, kms, import
spec.writeSecretRefobjectnowriteSecretRef names the Secret that receives the private key once, with type exported; required there and allowed only there. The Secret is owned by this resource and holds the keys `private_key` and `key_type`; never stored in status. Example: `{name: int-ca-key}`.
spec.writeSecretRef.namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
statusobjectnostatus is the observed state of the PKI key; `id` holds the OpenBao key ID.
status.acquiredstringnoHow the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned.
status.conditions[]objectnoCurrent 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[]objectnoCondition contains details for one aspect of the current state of this API Resource.
status.conditions[].lastTransitionTimestring (date-time)yeslastTransitionTime 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[].messagestringyesmessage is a human readable message indicating details about the transition. This may be an empty string.
Constraintslength: <=32768
status.conditions[].observedGenerationinteger (int64)noobservedGeneration 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[].reasonstringyesreason 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[].statusstringyesstatus of the condition, one of True, False, Unknown.
Constraintsone of: True, False, Unknown
status.conditions[].typestringyestype 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.idstringnoIdentifier 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.namespacestringnoAbsolute 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.observedGenerationinteger (int64)noThe metadata.generation of this resource that the operator last reconciled.
status.pathstringnoFull 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.rotationNoncestringnoValue 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.serverIDstringnoCluster 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.writeOnlyHashstringnoKeyed 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.