Secrets engine resources · Kind catalogue · Examples
LDAPSecretsConfig¶
API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: ldapsecretsconfigs.secrets.openbaoconfig.io
Categories: openbao
LDAPSecretsConfig sets the directory connection of an LDAP secrets plugin mount (external plugin) at `<mount>/config`: where the directory is and the account OpenBao binds as to manage passwords. A singleton per mount; it is never deleted.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: ldap
url: ldaps://ldap.example.com
bindDN: cn=openbao,ou=services,dc=example,dc=com
bindPassSecretRef: {name: ldap-bind, key: password}
schema: openldapExample¶
examples/secrets/ldapsecretsconfig.yaml
apiVersion: v1
kind: Secret
metadata:
name: ldap-bind
type: Opaque
stringData:
password: fake-bind-password
tls.key: fake-ldap-client-key-pem
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: LDAPSecretsConfig
metadata:
name: ldap
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: ldap
bindDN: cn=openbao,ou=services,dc=example,dc=org
bindPassSecretRef:
name: ldap-bind
key: password
url: ldaps://ldap1.example.org,ldaps://ldap2.example.org
userDN: ou=people,dc=example,dc=org
userAttr: uid
upnDomain: example.org
certificate: |
-----BEGIN CERTIFICATE-----
ZmFrZS1sZGFwLWNh
-----END CERTIFICATE-----
clientTLSCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1sZGFwLWNsaWVudC1jZXJ0
-----END CERTIFICATE-----
clientTLSKeySecretRef:
name: ldap-bind
key: tls.key
insecureTLS: false
startTLS: false
tlsMinVersion: tls12
tlsMaxVersion: tls13
connectionTimeout: 30s
requestTimeout: 1m30s
passwordPolicy: ldap-passwords
schema: openldap
skipStaticRoleImportRotation: true
On GitHub: ldapsecretsconfig.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 directory connection of the LDAP secrets plugin at `<mountPath>/config`. The bind password is written whenever any field or the Secret changes, which overwrites a password changed by rotate-root; rotate the Secret instead of calling rotate-root on a mount this resource manages. 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' (deletionPolicy must be Orphan: the plugin configuration is kept when the resource is deleted)CEL: has(self.clientTLSCert) == has(self.clientTLSKeySecretRef) (set clientTLSCert and clientTLSKeySecretRef together)CEL: !has(self.url) || self.url == self.url.lowerAscii() (url must be lowercase: OpenBao stores it lowercased)CEL: (has(self.tlsMaxVersion) ? self.tlsMaxVersion : 'tls12') >= (has(self.tlsMinVersion) ? self.tlsMinVersion : 'tls12') (tlsMaxVersion must not be lower than tlsMinVersion; both default to tls12)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.bindDN | string | yes | bindDN is the distinguished name OpenBao binds as to manage passwords (`binddn`). Example: `cn=openbao,ou=services,dc=example,dc=com`. | Constraintslength: >=1, <=1024 | |
spec.bindPassSecretRef | object | yes | bindPassSecretRef selects the Secret key holding the password of bindDN (`bindpass`). Read from a Secret key; never stored in status. Write-only. Example: `{name: ldap-bind, key: password}`. | ||
spec.bindPassSecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.bindPassSecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.certificate | string | no | certificate is the PEM CA certificate that verifies the directory's TLS certificate (`certificate`). Example: `-----BEGIN CERTIFICATE-----...`. | Constraintslength: <=65536 | |
spec.clientTLSCert | string | no | clientTLSCert is the PEM client certificate presented to the directory (`client_tls_cert`); set together with clientTLSKeySecretRef. OpenBao does not return it on read, so a change in OpenBao is not detected. Example: `-----BEGIN CERTIFICATE-----...`. | Constraintslength: <=65536 | |
spec.clientTLSKeySecretRef | object | no | clientTLSKeySecretRef selects the Secret key holding the PEM key of clientTLSCert (`client_tls_key`). Read from a Secret key; never stored in status. Write-only. Example: `{name: ldap-client, key: tls.key}`. | ||
spec.clientTLSKeySecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.clientTLSKeySecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
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.connectionTimeout | string | no | connectionTimeout is how long to wait for a connection before trying the next URL (`connection_timeout`), a duration. Defaults to `30s`. Example: `10s`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
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.insecureTLS | boolean | no | insecureTLS skips verification of the directory's TLS certificate (`insecure_tls`); not for production. 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 | "ldap" | mountPath is the path the LDAP secrets plugin is mounted at. Defaults to `ldap`. Immutable. Example: `ldap`. | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: >=1, <=256 |
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.passwordPolicy | string | no | passwordPolicy is the OpenBao password policy that generates passwords (`password_policy`). Empty uses the plugin default. Example: `ldap`. | Constraintslength: <=128 | |
spec.requestTimeout | string | no | requestTimeout is how long to wait for a response to a directory request (`request_timeout`), a duration. Defaults to `90s`. Example: `30s`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.schema | string | no | schema is the directory type (`schema`). Allowed: openldap, racf, ad. Defaults to openldap. | Constraintsone of:openldap, racf, ad | |
spec.skipStaticRoleImportRotation | boolean | no | skipStaticRoleImportRotation is the default for new static roles: do not rotate the password when the role is created (`skip_static_role_import_rotation`). Defaults to false. | ||
spec.startTLS | boolean | no | startTLS issues a STARTTLS command after connecting over plain LDAP (`starttls`). Defaults to false. | ||
spec.tlsMaxVersion | string | no | tlsMaxVersion is the maximum TLS version accepted from the directory (`tls_max_version`); not lower than tlsMinVersion. Allowed: tls10, tls11, tls12, tls13. Defaults to tls12. | Constraintsone of:tls10, tls11, tls12, tls13 | |
spec.tlsMinVersion | string | no | tlsMinVersion is the minimum TLS version accepted from the directory (`tls_min_version`). Allowed: tls10, tls11, tls12, tls13. Defaults to tls12. | Constraintsone of:tls10, tls11, tls12, tls13 | |
spec.upnDomain | string | no | upnDomain is the userPrincipalName domain, so users can be found as `<name>@<upnDomain>` (`upndomain`). Example: `example.com`. | Constraintslength: <=256 | |
spec.url | string | no | url is the directory URL in lower case (`url`); separate several URLs with commas, tried in order. Defaults to `ldap://127.0.0.1`. Example: `ldaps://ldap.example.com`. | Constraintslength: <=2048CEL: !self.matches('://[^/?#]*@') (url must not contain credentials (user:password@ or token@): use the secret reference fields) | |
spec.userAttr | string | no | userAttr is the attribute that holds the user name (`userattr`), such as cn, uid or userPrincipalName. Defaults to the schema's attribute (cn for openldap). Example: `uid`. | Constraintslength: <=256 | |
spec.userDN | string | no | userDN is the base DN under which user entries are searched (`userdn`). Example: `ou=users,dc=example,dc=com`. | Constraintslength: <=1024 | |
status | object | no | status is the observed state of the LDAP secrets plugin 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. |