Skip to content

Authentication resources · Kind catalogue · Examples

AppRoleSecretID

API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: approlesecretids.auth.openbaoconfig.io
Categories: openbao

AppRoleSecretID generates a secret ID for an OpenBao AppRole role at auth/<mountPath>/role/<role>/secret-id and writes it, with the role ID, to a Kubernetes Secret. Use it to hand AppRole credentials to a workload; the operator rotates the secret ID before it expires.

Example:

spec:
  connectionRef:
    name: openbao
  roleRef:
    name: ci-deploy
  ttl: 720h
  writeSecretRef:
    name: ci-deploy-approle

Example

examples/auth/approlesecretid.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AppRoleSecretID
metadata:
  name: ci-deployer-login
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  roleRef:
    name: ci-deployer
  metadata:
    team: platform
    pipeline: deploy
  cidrList:
    - 10.42.0.0/16
  tokenBoundCIDRs:
    - 10.42.0.0/16
  ttl: 12h
  numUses: 0
  writeSecretRef:
    name: ci-deployer-approle
  rotation:
    enabled: true
    renewBefore: 33%
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AppRoleSecretID
metadata:
  name: ci-deployer-login-by-name
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: approle
  roleName: ci-deployer
  ttl: 6h
  numUses: 10
  writeSecretRef:
    name: ci-deployer-approle-by-name
  rotation:
    enabled: true
    renewBefore: 2h

On GitHub: approlesecretid.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
specobjectyesDesired state of a secret ID of an AppRole role. Set exactly one of roleName and roleRef. The secret ID is written to the Secret named by writeSecretRef and never stored in status. A secret ID cannot be adopted: use creationPolicy Create or CreateOrAdopt.
ConstraintsCEL: has(self.roleName) != has(self.roleRef) (set exactly one of roleName and roleRef)
CEL: !has(self.mountPath) || has(self.roleName) (mountPath is only used with roleName; with roleRef the mount is taken from the AppRole)
CEL: !has(self.creationPolicy) || self.creationPolicy != 'Adopt' (a secret ID cannot be adopted; use Create or CreateOrAdopt)
CEL: has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)
CEL: has(self.roleName) == has(oldSelf.roleName) && (!has(self.roleName) || self.roleName == oldSelf.roleName) (roleName is immutable)
CEL: has(self.roleRef) == has(oldSelf.roleRef) && (!has(self.roleRef) || self.roleRef == oldSelf.roleRef) (roleRef is immutable)
CEL: has(self.metadata) == has(oldSelf.metadata) && (!has(self.metadata) || self.metadata == oldSelf.metadata) (metadata is immutable)
CEL: has(self.cidrList) == has(oldSelf.cidrList) && (!has(self.cidrList) || self.cidrList == oldSelf.cidrList) (cidrList is immutable)
CEL: has(self.tokenBoundCIDRs) == has(oldSelf.tokenBoundCIDRs) && (!has(self.tokenBoundCIDRs) || self.tokenBoundCIDRs == oldSelf.tokenBoundCIDRs) (tokenBoundCIDRs is immutable)
CEL: has(self.ttl) == has(oldSelf.ttl) && (!has(self.ttl) || self.ttl == oldSelf.ttl) (ttl is immutable)
CEL: has(self.numUses) == has(oldSelf.numUses) && (!has(self.numUses) || self.numUses == oldSelf.numUses) (numUses is immutable)
CEL: self.writeSecretRef == oldSelf.writeSecretRef (writeSecretRef is immutable)
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.cidrList[]stringnoCIDR blocks or IP addresses allowed to log in with this secret ID; must be a subset of the role's secretIDBoundCIDRs. Immutable. Maps to `cidr_list`. Example: [10.20.1.0/24]
Constraintsitems: <=64
list type: set
CEL: self.all(c, isCIDR(c) || isIP(c)) (cidrList entries must be CIDR blocks or IP addresses)
each item: length: <=64
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.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.metadatamap[string]stringnoKey-value metadata attached to the secret ID and to tokens issued with it. At most 32 entries. Immutable. Maps to `metadata` (sent as a JSON string). Example: {team: platform}
Constraintsproperties: <=32
spec.mountPathstringnoPath of the AppRole auth method, without the auth/ prefix. Only used with roleName; defaults to approle. With roleRef the mount comes from the AppRole. Immutable. Example: approle
Constraintspattern: ^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$
length: <=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.numUsesinteger (int32)noNumber of logins the secret ID allows. Must not exceed the role's secretIDNumUses; defaults to it. 0 means unlimited. Immutable. Maps to `num_uses`. Example: 5
Constraintsvalue: >=0
spec.roleNamestringnoName of the AppRole role in OpenBao. Set exactly one of roleName and roleRef. Immutable. Example: ci-deploy
Constraintspattern: ^[a-z0-9_]([a-z0-9_.-]*[a-z0-9_])?$
length: >=1, <=128
spec.roleRefobjectnoAppRole resource in this Kubernetes namespace whose mount and role name are used. The AppRole must be Ready and use the same connectionRef and namespace. Set exactly one of roleName and roleRef. Immutable. Example: {name: ci-deploy}
spec.roleRef.namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
spec.rotationobjectnoAutomatic replacement of the secret ID before it expires. Enabled by default; only applies to secret IDs with a TTL. Example: {renewBefore: 24h}
spec.rotation.enabledbooleannotrueTurns rotation on or off. Defaults to true. Example: false
spec.rotation.renewBeforestringnoHow long before expiry a new secret ID is generated: a duration or a percentage (1-99%) of the TTL. Defaults to a third of the TTL. Expiry is checked every drift interval, so keep this longer than the drift interval. The old secret ID is destroyed once the Secret holds the new one. Example: 25%
Constraintspattern: ^(([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+|[1-9][0-9]?%)$
length: <=32
spec.tokenBoundCIDRs[]stringnoCIDR blocks or IP addresses allowed to use tokens issued with this secret ID; must be a subset of the role's tokenBoundCIDRs. Immutable. Maps to `token_bound_cidrs`. Example: [10.20.1.0/24]
Constraintsitems: <=64
list type: set
CEL: self.all(c, isCIDR(c) || isIP(c)) (tokenBoundCIDRs entries must be CIDR blocks or IP addresses)
each item: length: <=64
spec.ttlstringnoLifetime of the secret ID, as a duration. Must not exceed the role's secretIDTTL; defaults to it. Immutable. Maps to `ttl`. Example: 168h
spec.writeSecretRefobjectyesSecret in this Kubernetes namespace, owned by this resource, that receives the keys role_id, secret_id and secret_id_accessor. A missing Secret or an empty secret_id key makes the operator generate a new secret ID. Required. Immutable. Example: {name: ci-deploy-approle}
spec.writeSecretRef.namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
statusobjectnoObserved state of the secret ID, written by the operator. status.id holds the secret ID accessor, never the secret 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.expirationTimestring (date-time)noTime the current secret ID expires; unset when it does not expire. Example: "2026-12-14T10:00:00Z"
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.retiredAccessors[]stringnoAccessors of replaced secret IDs, destroyed once the Secret holds the new secret ID. Example: [6f1c2e7a-0b9d-4c55-9a51-2f0e8f3d1b2c]
Constraintslist type: set
status.rolePathstringnoOpenBao path of the role the secret ID belongs to, relative to the OpenBao namespace. Example: auth/approle/role/ci-deploy
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.