System resources · Kind catalogue · Examples
AuthMount¶
API version: sys.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: authmounts.sys.openbaoconfig.io
Categories: openbao
AuthMount enables and tunes an OpenBao auth method at sys/auth/<path> (logins then go to auth/<path>/login). Use it before the auth kinds that configure the method, such as KubernetesAuthConfig and its roles. status.id holds the mount accessor. The default deletionPolicy Orphan keeps the mount; Delete disables it, which revokes every token it issued.
Example:
Example:
spec:
connectionRef:
name: openbao
type: kubernetes
path: kubernetes
description: Kubernetes workload logins
defaultLeaseTTL: 1hExample¶
examples/sys/authmount.yaml
# Enables the auth methods that the auth kinds then configure: AppRole for CI pipelines at approle-ci, with user
# lockout after five failed logins, plus LDAP and Kubernetes mounts.
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuthMount
metadata:
name: obco-approle
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 15m
managementPolicy: Manage
path: approle-ci
type: approle
description: AppRole logins for CI pipelines
local: false
sealWrap: false
externalEntropyAccess: false
forceNoCache: false
pluginVersion: ""
options: {}
defaultLeaseTTL: 1h
maxLeaseTTL: 24h
listingVisibility: hidden
auditNonHMACRequestKeys:
- role_id
auditNonHMACResponseKeys:
- role_id
passthroughRequestHeaders:
- X-Request-Id
allowedResponseHeaders:
- X-Request-Id
tokenType: default-service
userLockout:
threshold: 5
duration: 15m
counterResetDuration: 10m
disable: false
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuthMount
metadata:
name: obco-ldap
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 15m
managementPolicy: Manage
path: ldap
type: ldap
pluginRef:
name: obco-ldap-auth-plugin
description: LDAP logins through the external plugin registered by the Plugin obco-ldap-auth-plugin
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuthMount
metadata:
name: obco-kubernetes
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 15m
managementPolicy: Manage
path: kubernetes
type: kubernetes
description: Kubernetes ServiceAccount logins from the workload cluster
On GitHub: authmount.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 | Desired state of the auth method mount. | ConstraintsCEL:has(self.path) == has(oldSelf.path) && (!has(self.path) || self.path == oldSelf.path) (path is immutable)CEL: self.type == oldSelf.type (type is immutable)CEL: !has(self.userLockout) || self.type in ['approle', 'ldap', 'userpass'] (userLockout is supported only for the approle, ldap and userpass auth methods)CEL: has(self.local) == has(oldSelf.local) && (!has(self.local) || self.local == oldSelf.local) (local is immutable)CEL: has(self.sealWrap) == has(oldSelf.sealWrap) && (!has(self.sealWrap) || self.sealWrap == oldSelf.sealWrap) (sealWrap is immutable)CEL: has(self.externalEntropyAccess) == has(oldSelf.externalEntropyAccess) && (!has(self.externalEntropyAccess) || self.externalEntropyAccess == oldSelf.externalEntropyAccess) (externalEntropyAccess is immutable)CEL: has(self.forceNoCache) == has(oldSelf.forceNoCache) && (!has(self.forceNoCache) || self.forceNoCache == oldSelf.forceNoCache) (forceNoCache is immutable)CEL: has(self.pluginRef) == has(oldSelf.pluginRef) && (!has(self.pluginRef) || self.pluginRef == oldSelf.pluginRef) (pluginRef is immutable)CEL: !has(self.defaultLeaseTTL) || !has(self.maxLeaseTTL) || duration(self.maxLeaseTTL) == duration('0s') || duration(self.defaultLeaseTTL) <= duration(self.maxLeaseTTL) (defaultLeaseTTL must not exceed maxLeaseTTL)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.allowedResponseHeaders | []string | no | HTTP response headers the plugin backend is allowed to set. Maps to `allowed_response_headers`; order does not matter. Example: ["Location"] | Constraintsitems: <=64list type: set each item: length: >=1, <=256 | |
spec.auditNonHMACRequestKeys | []string | no | Request keys that audit devices log in plain text instead of HMAC-hashed. Maps to `audit_non_hmac_request_keys`; order does not matter. Example: ["role"] | Constraintsitems: <=64list type: set each item: length: >=1, <=256 | |
spec.auditNonHMACResponseKeys | []string | no | Response keys that audit devices log in plain text instead of HMAC-hashed. Maps to `audit_non_hmac_response_keys`; order does not matter. Example: ["lease_duration"] | Constraintsitems: <=64list type: set each item: length: >=1, <=256 | |
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.defaultLeaseTTL | string | no | Default lifetime of leases and tokens issued through this mount, as a duration; 0s uses the system default. Maps to `default_lease_ttl`. Must not exceed maxLeaseTTL. Example: 1h | 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.description | string | no | Human-readable description shown in the mount table. Maps to `description`. Example: Team A secrets | Constraintslength: <=1024 | |
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.externalEntropyAccess | boolean | no | Gives the mount access to the server's external entropy source. Maps to `external_entropy_access`. Default: false. Immutable: it cannot be added, changed or removed after creation. | ||
spec.forceNoCache | boolean | no | Disables caching of the mount's storage reads. Maps to `force_no_cache`. Default: false. Immutable: it cannot be added, changed or removed after creation. | ||
spec.listingVisibility | string | no | Whether the mount appears in the unauthenticated mount listing of the UI. Maps to `listing_visibility`. Allowed values: unauth (listed), hidden (not listed). Default: unset, which is not listed. | Constraintsone of:unauth, hidden | |
spec.local | boolean | no | Marks the mount as local to this server cluster. Maps to `local`. Default: false. Immutable: it cannot be added, changed or removed after creation. | ||
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.maxLeaseTTL | string | no | Maximum lifetime of leases and tokens issued through this mount, as a duration; 0s uses the system maximum. Maps to `max_lease_ttl`. Example: 24h | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
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.options | map[string]string | no | Plugin-specific mount options as string key/value pairs, sent when the mount is enabled. Maps to `options`. Example: {"version": "2"} for a KV version 2 engine. | Constraintsproperties: <=32each value: length: <=1024 | |
spec.passthroughRequestHeaders | []string | no | HTTP request headers passed through to the plugin backend. Maps to `passthrough_request_headers`; order does not matter. Example: ["X-Request-Id"] | Constraintsitems: <=64list type: set each item: length: >=1, <=256 | |
spec.path | string | no | Path the auth method is enabled at, without the auth/ prefix and without slashes at either end. Default: metadata.name. Immutable: it cannot be added, changed or removed after creation. Example: kubernetes-prod | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: <=256 | |
spec.pluginRef | object | no | Plugin in this namespace that registers the external plugin this mount runs. The mount waits until the Plugin is Ready, takes its version when pluginVersion is unset, and requires type to be the Plugin's catalog name. Immutable. Example: {name: openbao-plugin-auth-ldap} | ||
spec.pluginRef.name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
spec.pluginVersion | string | no | Plugin version the mount runs, for a registered versioned plugin; empty uses the built-in or unversioned plugin. Maps to `plugin_version`. Example: v0.20.0 | Constraintslength: <=128 | |
spec.sealWrap | boolean | no | Enables seal wrapping of the mount's storage. Maps to `seal_wrap`. Default: false. Immutable: it cannot be added, changed or removed after creation. | ||
spec.tokenType | string | no | Default type of token the auth method issues. Maps to `token_type`. Allowed values: default-service, default-batch, service, batch. Default: default-service. Example: service | Constraintsone of:default-service, default-batch, service, batch | |
spec.type | string | yes | Auth method type: a built-in method such as kubernetes, jwt, approle or userpass, or the name of a registered plugin. Maps to `type`. Immutable. Example: kubernetes | Constraintslength: >=1, <=128 | |
spec.userLockout | object | no | Lockout of users after repeated failed logins. Maps to `user_lockout_config`. Only for the approle, ldap and userpass auth methods; unset uses the server defaults. | ||
spec.userLockout.counterResetDuration | string | no | Time after which the failed-login counter is reset, as a duration. Maps to `lockout_counter_reset_duration`. Example: 30m | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.userLockout.disable | boolean | no | Turns user lockout off for this mount. Maps to `lockout_disable`. Default: false. Example: true | ||
spec.userLockout.duration | string | no | How long a locked-out user stays locked out, as a duration. Maps to `lockout_duration`. Example: 15m | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.userLockout.threshold | integer (int32) | no | Number of failed logins after which a user is locked out. Maps to `lockout_threshold`. Minimum 0. Example: 5 | Constraintsvalue: >=0 | |
status | object | no | Observed state reported by the operator; id holds the mount accessor. | ||
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. |