Secrets engine resources · Kind catalogue · Examples
PKIAutoTidy¶
API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: pkiautotidies.secrets.openbaoconfig.io
Categories: openbao
PKIAutoTidy sets the periodic tidy configuration of a PKI secrets engine at `<mount>/config/auto-tidy`, which removes expired certificates, issuers and ACME data on a schedule. A singleton per mount; it is never deleted.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: pki-int
enabled: true
intervalDuration: 24h
tidyCertStore: true
tidyRevokedCerts: trueExample¶
examples/secrets/pkiautotidy.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIAutoTidy
metadata:
name: obco-pki-int
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: obco-pki-int
enabled: true
intervalDuration: 12h
tidyCertStore: true
tidyRevokedCerts: true
tidyInvalidCerts: false
tidyRevokedCertIssuerAssociations: true
tidyExpiredIssuers: true
tidyMoveLegacyCABundle: false
tidyACME: true
safetyBuffer: 72h
revokedSafetyBuffer: 72h
issuerSafetyBuffer: 8760h
acmeAccountSafetyBuffer: 720h
pageSize: 1000
pauseDuration: 0s
maintainStoredCertificateCounts: true
publishStoredCertificateCountMetrics: true
On GitHub: pkiautotidy.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 periodic tidy configuration of a PKI secrets engine at `<mountPath>/config/auto-tidy`. It sets the schedule only; the operator never starts a tidy run itself. Fields left unset keep the server value. deletionPolicy must be Orphan. | ConstraintsCEL:has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)CEL: !has(self.deletionPolicy) || self.deletionPolicy == 'Orphan' (the auto-tidy configuration cannot be deleted; deletionPolicy must be Orphan)CEL: !self.?enabled.orValue(false) || self.?tidyCertStore.orValue(false) || self.?tidyRevokedCerts.orValue(false) || self.?tidyInvalidCerts.orValue(false) || self.?tidyRevokedCertIssuerAssociations.orValue(false) || self.?tidyExpiredIssuers.orValue(false) || self.?tidyMoveLegacyCABundle.orValue(false) || self.?tidyACME.orValue(false) (enabled requires at least one tidy operation)CEL: !self.?publishStoredCertificateCountMetrics.orValue(false) || self.?maintainStoredCertificateCounts.orValue(false) (publishStoredCertificateCountMetrics requires maintainStoredCertificateCounts)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.acmeAccountSafetyBuffer | string | no | acmeAccountSafetyBuffer is how long an inactive ACME account is kept (`acme_account_safety_buffer`), a duration. Defaults to `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.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.enabled | boolean | no | enabled turns on periodic tidy runs (`enabled`); requires at least one tidy operation. Defaults to false. | ||
spec.intervalDuration | string | no | intervalDuration is the time between tidy runs (`interval_duration`), a duration. Defaults to `12h`. Example: `24h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.issuerSafetyBuffer | string | no | issuerSafetyBuffer is how long after expiry an issuer is kept (`issuer_safety_buffer`), a duration. Defaults to `8760h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.maintainStoredCertificateCounts | boolean | no | maintainStoredCertificateCounts keeps a running count of stored and revoked certificates (`maintain_stored_certificate_counts`). 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.pageSize | integer (int32) | no | pageSize is the number of certificates processed per storage page (`page_size`). Minimum 5. Defaults to 1000. | Constraintsvalue: >=5 | |
spec.pauseDuration | string | no | pauseDuration is the pause between certificates, to limit storage load (`pause_duration`), a duration. Defaults to `0s`. Example: `100ms`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.publishStoredCertificateCountMetrics | boolean | no | publishStoredCertificateCountMetrics publishes those counts as metrics (`publish_stored_certificate_count_metrics`); requires maintainStoredCertificateCounts. Defaults to false. | ||
spec.revokedSafetyBuffer | string | no | revokedSafetyBuffer is how long after expiry a revoked certificate is kept (`revoked_safety_buffer`), a duration. Defaults to safetyBuffer. Example: `720h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.safetyBuffer | string | no | safetyBuffer is how long after expiry a certificate is kept (`safety_buffer`), a duration. Defaults to `72h`. Example: `168h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.tidyACME | boolean | no | tidyACME removes expired ACME accounts, orders and challenges (`tidy_acme`). Defaults to false. | ||
spec.tidyCertStore | boolean | no | tidyCertStore removes expired certificates from storage (`tidy_cert_store`). Defaults to false. | ||
spec.tidyExpiredIssuers | boolean | no | tidyExpiredIssuers removes issuers that expired more than issuerSafetyBuffer ago (`tidy_expired_issuers`). Defaults to false. | ||
spec.tidyInvalidCerts | boolean | no | tidyInvalidCerts removes certificates that cannot be parsed (`tidy_invalid_certs`). Defaults to false. | ||
spec.tidyMoveLegacyCABundle | boolean | no | tidyMoveLegacyCABundle moves the pre-multi-issuer CA bundle to a backup location (`tidy_move_legacy_ca_bundle`). Defaults to false. | ||
spec.tidyRevokedCertIssuerAssociations | boolean | no | tidyRevokedCertIssuerAssociations repairs the issuer association of revoked certificates (`tidy_revoked_cert_issuer_associations`). Defaults to false. | ||
spec.tidyRevokedCerts | boolean | no | tidyRevokedCerts removes expired certificates from the revocation list (`tidy_revoked_certs`). Defaults to false. | ||
status | object | no | status is the observed state of the auto-tidy 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. |