Authentication resources · Kind catalogue · Examples
TokenRole¶
API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: tokenroles.auth.openbaoconfig.io
Categories: openbao
TokenRole manages a role of the OpenBao token store at auth/token/roles/<name>. Use it to let callers create tokens with auth/token/create/<name> under fixed policy, TTL and renewal limits, for example for orchestration tools that mint child tokens.
Example:
Example:
spec:
connectionRef:
name: openbao
allowedPolicies: [app-read]
orphan: true
tokenPeriod: 24h
tokenType: serviceExample¶
examples/auth/tokenrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: TokenRole
metadata:
name: app-issuer
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
name: app-issuer
allowedPolicies:
- app-reader
- app-writer
disallowedPolicies:
- admin
allowedPoliciesGlob:
- app-*
disallowedPoliciesGlob:
- root-*
allowedEntityAliases:
- app-*
orphan: false
renewable: true
pathSuffix: app-v1
tokenExplicitMaxTTL: 24h
tokenPeriod: 1h
tokenBoundCIDRs:
- 10.42.0.0/16
tokenNumUses: 0
tokenType: service
tokenNoDefaultPolicy: true
On GitHub: tokenrole.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 a token store role, written to auth/token/roles/<name>. tokenType batch requires orphan true, renewable false and no tokenPeriod or tokenExplicitMaxTTL. | ConstraintsCEL:has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name is immutable)CEL: !has(self.tokenType) || self.tokenType != 'batch' || (has(self.orphan) && self.orphan && has(self.renewable) && !self.renewable && !has(self.tokenPeriod) && !has(self.tokenExplicitMaxTTL)) (tokenType batch requires orphan true, renewable false and no tokenPeriod or tokenExplicitMaxTTL)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.allowedEntityAliases | []string | no | Entity alias names, or glob patterns, a token created against this role may be bound to. OpenBao stores them in lower case. Maps to `allowed_entity_aliases`. Example: ["ci-*"] | Constraintsitems: <=256list type: set each item: pattern: ^[^A-Z]+$each item: length: <=256 | |
spec.allowedPolicies | []string | no | Policies a token created against this role may have. When set, a creator may only request a subset; unset allows any policy of the creating token. Lower case names. Maps to `allowed_policies`. Example: [app-read, app-write] | Constraintsitems: <=256list type: set each item: pattern: ^[^A-Z\s]+$each item: length: <=128 | |
spec.allowedPoliciesGlob | []string | no | Glob patterns of policies a token created against this role may have, in addition to allowedPolicies. Lower case. Maps to `allowed_policies_glob`. Example: ["app-*"] | Constraintsitems: <=256list type: set each item: pattern: ^[^A-Z\s]+$each item: length: <=128 | |
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.disallowedPolicies | []string | no | Policies a token created against this role must never have; takes precedence over allowedPolicies. Lower case names. Maps to `disallowed_policies`. Example: [root, admin] | Constraintsitems: <=256list type: set each item: pattern: ^[^A-Z\s]+$each item: length: <=128 | |
spec.disallowedPoliciesGlob | []string | no | Glob patterns of policies a token created against this role must never have. Lower case. Maps to `disallowed_policies_glob`. Example: ["admin-*"] | Constraintsitems: <=256list type: set each item: pattern: ^[^A-Z\s]+$each item: length: <=128 | |
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.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.name | string | no | Name of the token role in OpenBao. Defaults to metadata.name. Case sensitive. Immutable. Example: ci-runner | Constraintspattern:^[A-Za-z0-9_]([A-Za-z0-9_.-]*[A-Za-z0-9_])?$length: >=1, <=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.orphan | boolean | no | Creates tokens without a parent, so they are not revoked when the creating token is revoked. Defaults to false. Maps to `orphan`. Example: true | ||
spec.pathSuffix | string | no | Suffix appended to the creation path (auth/token/create/<name>/<pathSuffix>) so tokens can be revoked by prefix. Letters, digits, underscore, dot and dash; must not contain "..". Maps to `path_suffix`. Example: v2 | Constraintspattern:^\w[\w.-]+\w$length: <=128 CEL: !self.contains('..') (pathSuffix must not contain '..') | |
spec.renewable | boolean | no | Allows tokens created against this role to be renewed past their initial TTL, up to the max TTL. OpenBao defaults to true. Maps to `renewable`. Example: false | ||
spec.tokenBoundCIDRs | []string | no | Client CIDR blocks or IP addresses allowed to use issued tokens. Unset allows any address. Maps to `token_bound_cidrs`. Example: [10.0.0.0/8, 192.168.1.10] | Constraintsitems: <=64list type: set CEL: self.all(c, isCIDR(c) || isIP(c)) (tokenBoundCIDRs entries must be CIDR blocks or IP addresses)each item: length: <=64 | |
spec.tokenExplicitMaxTTL | string | no | Hard cap on the lifetime of issued tokens that renewals cannot extend, as a duration. Unset or 0 means no explicit cap. Maps to `token_explicit_max_ttl`. Example: 24h | ||
spec.tokenNoDefaultPolicy | boolean | no | When true, the default policy is not attached to issued tokens; only the listed policies apply. Defaults to false. Maps to `token_no_default_policy`. Example: true | ||
spec.tokenNumUses | integer (int32) | no | Maximum number of requests an issued token may make; 0 or unset means unlimited. Maps to `token_num_uses`. Example: 10 | Constraintsvalue: >=0 | |
spec.tokenPeriod | string | no | Makes issued tokens periodic: they never expire as long as they are renewed within this duration, and each renewal resets the TTL to it. Unset or 0 means not periodic. Maps to `token_period`. Example: 1h | ||
spec.tokenType | string | no | Type of token to issue. One of default (the mount's default, normally service), service (renewable, can create child tokens) or batch (lightweight, not renewable). Maps to `token_type`. Example: service | Constraintsone of:default, service, batch | |
status | object | no | Observed state of the token role, written by the operator. | ||
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. |