Secrets engine resources · Kind catalogue · Examples
PKIConfig¶
API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: pkiconfigs.secrets.openbaoconfig.io
Categories: openbao
PKIConfig sets the mount-wide configuration of a PKI secrets engine: AIA URLs (`config/urls`), CRL (`config/crl`), cluster address (`config/cluster`) and default issuer (`config/issuers`). Use one per mount; it is never deleted.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: pki-int
urls:
issuingCertificates: [https://openbao.example.com/v1/pki-int/ca]
crlDistributionPoints: [https://openbao.example.com/v1/pki-int/crl]
issuers:
default: {issuerName: int-2026}Example¶
examples/secrets/pkiconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIConfig
metadata:
name: obco-pki-int
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: obco-pki-int
cluster:
path: https://openbao.openbao-config.example.com/v1/openbao-config/obco-pki-int
aiaPath: http://openbao.openbao-config.example.com/v1/openbao-config/obco-pki-int
urls:
issuingCertificates:
- "{{cluster_aia_path}}/issuer/{{issuer_id}}/der"
crlDistributionPoints:
- "{{cluster_aia_path}}/issuer/{{issuer_id}}/crl/der"
deltaCRLDistributionPoints:
- "{{cluster_aia_path}}/issuer/{{issuer_id}}/crl/delta/der"
ocspServers:
- "{{cluster_path}}/ocsp"
enableTemplating: true
crl:
expiry: 72h
disable: false
ocspDisable: false
ocspExpiry: 12h
autoRebuild: true
autoRebuildGracePeriod: 12h
enableDelta: true
deltaRebuildInterval: 15m
allowExpiredCertRevocation: false
issuers:
default:
issuerRef:
name: obco-int-2026
defaultFollowsLatestIssuer: false
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIConfig
metadata:
name: obco-pki-root
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: obco-pki-root
issuers:
default:
issuerName: obco-root-2026
On GitHub: pkiconfig.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 mount-wide configuration of a PKI secrets engine: AIA URLs, CRL, cluster address and the default issuer. Every field of urls and crl is managed: an unset field or section is returned to its OpenBao default. The cluster fields and issuers are managed only when set, because OpenBao cannot clear a cluster path and the default issuer has no default to return to. Set at least one section. deletionPolicy must be Orphan. | ConstraintsCEL:has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)CEL: has(self.urls) || has(self.crl) || has(self.cluster) || has(self.issuers) (set at least one of urls, crl, cluster and issuers)CEL: !has(self.deletionPolicy) || self.deletionPolicy == 'Orphan' (the PKI mount configuration cannot be deleted; deletionPolicy must be Orphan)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.cluster | object | no | cluster is the cluster-local address configuration (`<mountPath>/config/cluster`). | ConstraintsCEL:has(self.path) || has(self.aiaPath) (set path or aiaPath) | |
spec.cluster.aiaPath | string | no | aiaPath is the URL of this mount used in AIA fields (`aia_path`); it may be a non-TLS URL. Example: `http://pki.example.com/v1/pki-int`. | Constraintspattern:^[A-Za-z][A-Za-z0-9+.-]*://[^/]+.*$length: <=1024 | |
spec.cluster.path | string | no | path is the URL of this mount on this cluster (`path`). Example: `https://openbao.example.com/v1/pki-int`. | Constraintspattern:^[A-Za-z][A-Za-z0-9+.-]*://[^/]+.*$length: <=1024 | |
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.crl | object | no | crl is the revocation configuration (`<mountPath>/config/crl`). | ||
spec.crl.allowExpiredCertRevocation | boolean | no | allowExpiredCertRevocation allows revoking certificates that have already expired (`allow_expired_cert_revocation`). Defaults to false. | ||
spec.crl.autoRebuild | boolean | no | autoRebuild rebuilds the CRL before it expires instead of on every revocation (`auto_rebuild`). Defaults to false. | ||
spec.crl.autoRebuildGracePeriod | string | no | autoRebuildGracePeriod is how long before expiry an automatic rebuild runs (`auto_rebuild_grace_period`), a duration shorter than expiry. Defaults to `12h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.crl.deltaRebuildInterval | string | no | deltaRebuildInterval is how often delta CRLs are rebuilt (`delta_rebuild_interval`), a duration shorter than expiry. Defaults to `15m`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.crl.disable | boolean | no | disable turns off CRL building (`disable`). Defaults to false. | ||
spec.crl.enableDelta | boolean | no | enableDelta builds delta CRLs between full rebuilds (`enable_delta`); requires autoRebuild. Defaults to false. | ||
spec.crl.expiry | string | no | expiry is the validity of a generated CRL (`expiry`), a duration. Defaults to `72h`. Example: `48h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.crl.ocspDisable | boolean | no | ocspDisable turns off the OCSP responder (`ocsp_disable`). Defaults to false. | ||
spec.crl.ocspExpiry | string | no | ocspExpiry is the validity of OCSP responses (`ocsp_expiry`), a duration; `0s` means no expiry. Defaults to `12h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
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.issuers | object | no | issuers selects the default issuer (`<mountPath>/config/issuers`). | ||
spec.issuers.default | object | yes | default selects the issuer used by requests that do not name one (`default`). Example: `{issuerName: int-2026}`. | ConstraintsCEL:has(self.issuerName) != has(self.issuerRef) (set exactly one of issuerName and issuerRef) | |
spec.issuers.default.issuerName | string | no | issuerName is the name or ID of the issuer in OpenBao. Example: `int-2026`. | Constraintslength: >=1, <=128 | |
spec.issuers.default.issuerRef | object | no | issuerRef names a PKIIssuer in the same namespace and PKI mount; it must be Ready. Example: `{name: int-2026}`. | ||
spec.issuers.default.issuerRef.name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
spec.issuers.defaultFollowsLatestIssuer | boolean | no | defaultFollowsLatestIssuer moves the default to every newly generated or imported issuer (`default_follows_latest_issuer`). Defaults to 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.mountPath | string | no | "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.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.urls | object | no | urls is the mount-wide AIA configuration (`<mountPath>/config/urls`). | ||
spec.urls.crlDistributionPoints | []string | no | crlDistributionPoints are the URLs where the CRL can be fetched (`crl_distribution_points`). Up to 16. Example: `[https://openbao.example.com/v1/pki-int/crl]`. | Constraintsitems: <=16list type: atomic each item: length: <=1024 | |
spec.urls.deltaCRLDistributionPoints | []string | no | deltaCRLDistributionPoints are the URLs where the delta CRL can be fetched (`delta_crl_distribution_points`). Up to 16. | Constraintsitems: <=16list type: atomic each item: length: <=1024 | |
spec.urls.enableTemplating | boolean | no | enableTemplating allows `{{cluster_path}}`, `{{cluster_aia_path}}` and `{{issuer_id}}` in the URLs (`enable_templating`); the cluster section must then be set. Defaults to false. | ||
spec.urls.issuingCertificates | []string | no | issuingCertificates are the URLs where the issuing CA certificate can be fetched (`issuing_certificates`). Up to 16. Example: `[https://openbao.example.com/v1/pki-int/ca]`. | Constraintsitems: <=16list type: atomic each item: length: <=1024 | |
spec.urls.ocspServers | []string | no | ocspServers are the URLs of the OCSP responders (`ocsp_servers`). Up to 16. Example: `[https://openbao.example.com/v1/pki-int/ocsp]`. | Constraintsitems: <=16list type: atomic each item: length: <=1024 | |
status | object | no | status is the observed state of the PKI mount configuration. | ||
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. |