Access resources · Kind catalogue · Examples
AccessGrant¶
API version: access.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: accessgrants.access.openbaoconfig.io
Categories: openbao
AccessGrant gives Kubernetes ServiceAccounts access to KV version 2 secrets (the machine access model). It writes one ACL policy, sys/policies/acl/grant_<namespace>_<name>, rendered from rules that cite AccessLevels, and one role per subject on a Kubernetes auth method, auth/<mount>/role/grant_<namespace>_<name>_<index>, that issues tokens with that policy. With the default deletionPolicy Orphan the policy and roles stay when the grant is deleted; with Delete they are removed.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: kubernetes
subjects:
- name: app
namespace: payments
rules:
- mount: secret
path: payments/{sa.name}/*
level: readerExample¶
examples/access/accessgrant.yaml
# Gives the payments ServiceAccounts write access to their own KV paths and read access to shared paths per
# organization, through one generated ACL policy and one Kubernetes auth role per subject.
apiVersion: access.openbaoconfig.io/v1alpha1
kind: AccessGrant
metadata:
name: payments-workloads
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
driftInterval: 15m
managementPolicy: Manage
mountPath: kubernetes
subjects:
- name: payments-api
namespace: payments
- name: "*"
namespaceSelector:
matchLabels:
team: payments
tier: workloads
rules:
- mount: secret
path: apps/{sa.namespace}/{sa.name}/*
metadataPath: apps/{sa.namespace}/{sa.name}
level: write
- mount: secret
path: shared/{org}/{sa.namespace}/+/*
metadataPath: shared/{org}/{sa.namespace}/*
level: read
organizations:
- acme
- globex
tokenTTL: 15m
---
apiVersion: access.openbaoconfig.io/v1alpha1
kind: AccessGrant
metadata:
name: payments-batch
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
authMountRef:
name: kubernetes
subjects:
- name: nightly-report
namespace: payments
rules:
- mount: secret
path: reports/*
level: read
tokenTTL: 10m
---
apiVersion: access.openbaoconfig.io/v1alpha1
kind: AccessGrant
metadata:
name: payments-migrations
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountAccessor: auth_kubernetes_1a2b3c4d
subjects:
- name: schema-migrator
namespace: payments
rules:
- mount: secret
path: databases/payments
level: owner
On GitHub: accessgrant.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: the auth method, the ServiceAccount subjects and the secret paths they get access to. | ConstraintsCEL:(has(self.mountPath) ? 1 : 0) + (has(self.mountAccessor) ? 1 : 0) + (has(self.authMountRef) ? 1 : 0) == 1 (set exactly one of mountPath, mountAccessor and authMountRef)CEL: !self.subjects.exists(s, has(s.namespaceSelector) || (has(s.__namespace__) && s.__namespace__.contains('*'))) || self.rules.all(r, r.path.contains('{sa.namespace}') && (!has(r.metadataPath) || r.metadataPath.contains('{sa.namespace}'))) (a subject with a namespace glob or a namespaceSelector requires {sa.namespace} in every rule path and metadataPath)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.authMountRef | object | no | AuthMount resource, in the same Kubernetes namespace, whose Kubernetes auth method the roles are created on; it must be Ready. Set exactly one of mountPath, mountAccessor and authMountRef. | ||
spec.authMountRef.name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | 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.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.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.mountAccessor | string | no | Accessor of the Kubernetes auth method the roles are created on, as listed by sys/auth. Set exactly one of mountPath, mountAccessor and authMountRef. Example: auth_kubernetes_1a2b3c4d | Constraintslength: >=1, <=128 | |
spec.mountPath | string | no | Path of the Kubernetes auth method the roles are created on, without the auth/ prefix. Set exactly one of mountPath, mountAccessor and authMountRef. Example: kubernetes | Constraintspattern:^[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.rules | []object | yes | Secret paths and the level granted on each, 1 to 8 entries, rendered into the ACL policy grant_<namespace>_<name>. In a path, {sa.namespace} and {sa.name} stand for the namespace and name of the ServiceAccount that logged in; OpenBao fills them in per request through identity templating. | Constraintsitems: >=1, <=8 | |
spec.rules[] | object | no | Grants one AccessLevel on a pair of secret paths of a KV version 2 mount. A path is a list of segments separated by "/": a literal, "+" (exactly one segment), or one of the tokens {org}, {sa.namespace} and {sa.name}; the last segment may also be "*" or end with "*". | ConstraintsCEL:(self.path.contains('{org}') || (has(self.metadataPath) && self.metadataPath.contains('{org}'))) == (has(self.organizations) && size(self.organizations) > 0) (a rule lists organizations exactly when its path or metadataPath uses {org}) | |
spec.rules[].level | string | yes | Name of the AccessLevel, in the same Kubernetes namespace, granted on the paths. Example: reader | Constraintslength: >=1, <=253 | |
spec.rules[].metadataPath | string | no | Secret path below the mount that the level's metadata capabilities apply to; the policy grants them on <mount>/metadata/<metadataPath>. Same syntax as path. Default: the value of path. Example: apps/* | Constraintspattern:^((([A-Za-z0-9_-][A-Za-z0-9._-]*|\.[A-Za-z0-9_-][A-Za-z0-9._-]*|\.\.[A-Za-z0-9._-]+)|\+|\{org\}|\{sa\.namespace\}|\{sa\.name\})/)*(([A-Za-z0-9_-][A-Za-z0-9._-]*|\.[A-Za-z0-9_-][A-Za-z0-9._-]*|\.\.[A-Za-z0-9._-]+)\*?|\+|\{org\}|\{sa\.namespace\}|\{sa\.name\}|\*)$length: >=1, <=256 | |
spec.rules[].mount | string | yes | Path of the KV version 2 secrets engine, without leading or trailing slash. Example: secret | Constraintspattern:^[A-Za-z0-9_-]+(/[A-Za-z0-9_-]+)*$length: >=1, <=128 | |
spec.rules[].organizations | []string | no | Values that {org} takes in path and metadataPath; the rule is rendered once per organization. Set exactly when a path uses {org}. Lowercase letters, digits and "-", at most 40 characters. Example: [acme, globex] | Constraintsitems: <=32list type: set each item: pattern: ^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$each item: length: <=40 | |
spec.rules[].path | string | yes | Secret path below the mount that the level's data capabilities apply to; the policy grants them on <mount>/data/<path>. The level's versions grant applies to the same path under delete/, undelete/ and destroy/. Example: apps/{sa.namespace}/* | Constraintspattern:^((([A-Za-z0-9_-][A-Za-z0-9._-]*|\.[A-Za-z0-9_-][A-Za-z0-9._-]*|\.\.[A-Za-z0-9._-]+)|\+|\{org\}|\{sa\.namespace\}|\{sa\.name\})/)*(([A-Za-z0-9_-][A-Za-z0-9._-]*|\.[A-Za-z0-9_-][A-Za-z0-9._-]*|\.\.[A-Za-z0-9._-]+)\*?|\+|\{org\}|\{sa\.namespace\}|\{sa\.name\}|\*)$length: >=1, <=256 | |
spec.subjects | []object | yes | ServiceAccounts that get access, 1 to 8 entries. Each subject gets its own Kubernetes auth role, grant_<namespace>_<name>_<index>, because OpenBao matches the names and namespaces of a role as two independent lists. | Constraintsitems: >=1, <=8 | |
spec.subjects[] | object | no | A set of Kubernetes ServiceAccounts that log in with one Kubernetes auth role of their own. Set exactly one of namespace and namespaceSelector. | ConstraintsCEL:has(self.__namespace__) != has(self.namespaceSelector) (set exactly one of namespace and namespaceSelector) | |
spec.subjects[].name | string | yes | Name of the ServiceAccount; maps to the role's `bound_service_account_names`. A leading or trailing "*" matches several names. Example: app | Constraintspattern:^\*?[a-z0-9.-]*\*?$length: >=1, <=253 | |
spec.subjects[].namespace | string | no | Kubernetes namespace of the ServiceAccount; maps to the role's `bound_service_account_namespaces`. A leading or trailing "*" matches several namespaces, which makes the subject broad: every rule path must then contain {sa.namespace}. Example: payments | Constraintspattern:^\*?[a-z0-9-]*\*?$length: >=1, <=63 | |
spec.subjects[].namespaceSelector | object | no | Selects the Kubernetes namespaces of the ServiceAccount by label instead of by name; maps to the role's `bound_service_account_namespace_selector`. This makes the subject broad: every rule path must then contain {sa.namespace}. | ||
spec.subjects[].namespaceSelector.matchLabels | map[string]string | yes | Labels a Kubernetes namespace must carry, all of them, for its ServiceAccounts to match; sent to the role as the `bound_service_account_namespace_selector` label selector. Example: {team: payments} | Constraintsproperties: >=1, <=16 | |
spec.tokenTTL | string | no | "15m" | Lifetime of the tokens the roles issue, as a duration; maps to the role's `token_ttl` (sent in seconds). Default: 15m. Example: 1h | |
status | object | no | Observed state reported by the operator: conditions, the role names to log in with and the owned OpenBao objects. | ||
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.children | []object | no | Every OpenBao object the grant owns: its ACL policy and Kubernetes auth roles. With deletionPolicy Delete, deleting the grant deletes exactly these. | ||
status.children[] | object | no | One OpenBao object created and owned by this resource; with deletionPolicy Delete it is removed when the resource is deleted. | ||
status.children[].kind | string | yes | Kind of the OpenBao object: Policy (an ACL policy), KubernetesAuthRole (a Kubernetes auth role) or Group (an external identity group, together with its group alias). | Constraintsone of:Policy, KubernetesAuthRole, Group | |
status.children[].namespace | string | no | OpenBao namespace of the object, relative to status.namespace; empty means status.namespace itself. Example: team-a | ||
status.children[].path | string | yes | OpenBao API path of the object in its namespace. Example: sys/policies/acl/grant_apps_reader | ||
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.roles | []string | no | Names of the Kubernetes auth roles, one per subject in spec order. A ServiceAccount logs in with the role of its subject. Example: [grant_payments_app-reader_0] | ||
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. |