Access resources · Kind catalogue · Examples
AccessLayout¶
API version: access.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: accesslayouts.access.openbaoconfig.io
Categories: openbao
AccessLayout gives people, by identity provider group, access to KV version 2 secrets (the human access model). For each role, OpenBao namespace and organization it writes an ACL policy, sys/policies/acl/layout_<namespace>_<name>_<role>[_<org>], and per auth mount an external group identity/group/name/<policy>_<mount> with that policy and a group alias matching the identity provider group. An update that deletes a policy or group the layout created before needs the annotation openbaoconfig.io/allow-disruptive-update: "true". Default deletionPolicy Orphan keeps the objects.
Example:
Example:
spec:
connectionRef:
name: openbao
authMounts: [oidc]
paths:
- mount: secret
path: team-a/*
roles:
- name: developer
levels:
- level: writerExample¶
examples/access/accesslayout.yaml
# Gives people access by identity provider group: per organization, developers can write and leads own the org
# paths, while in the prod namespace developers only read and leads write.
apiVersion: access.openbaoconfig.io/v1alpha1
kind: AccessLayout
metadata:
name: platform-teams
namespace: openbao-config
annotations:
openbaoconfig.io/allow-disruptive-update: "false"
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
driftInterval: 15m
managementPolicy: Manage
authMounts:
- oidc
organizations:
- acme
- globex
groupAliasTemplate: "{org}_{role}"
paths:
- mount: orgs
path: "{org}/+/*"
metadataPath: "{org}/*"
roles:
- name: developer
levels:
- namespace: ""
level: write
- namespace: prod
level: read
- name: lead
levels:
- namespace: ""
level: owner
- namespace: prod
level: write
On GitHub: accesslayout.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 mounts, secret paths and the role-by-namespace access matrix. | ConstraintsCEL:!has(self.groupAliasTemplate) || self.groupAliasTemplate.contains('{role}') (groupAliasTemplate must contain {role})CEL: !has(self.groupAliasTemplate) || self.groupAliasTemplate.contains('{org}') == (has(self.organizations) && size(self.organizations) > 0) (groupAliasTemplate contains {org} exactly when organizations are set)CEL: self.paths.all(p, !p.path.contains('{sa.') && (!has(p.metadataPath) || !p.metadataPath.contains('{sa.'))) ({sa.namespace} and {sa.name} are only valid in AccessGrant rules)CEL: !self.paths.exists(p, p.path.contains('{org}') || (has(p.metadataPath) && p.metadataPath.contains('{org}'))) || (has(self.organizations) && size(self.organizations) > 0) (paths that use {org} require organizations)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.authMounts | []string | yes | Paths of the OIDC or JWT auth methods people log in with, without the auth/ prefix, 1 to 4 entries. Each gets its own external group and group alias per policy; every OpenBao namespace of the layout must have each of them. Example: [oidc] | Constraintsitems: >=1, <=4list type: set each item: pattern: ^[A-Za-z0-9_-]+$each item: length: <=64 | |
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.groupAliasTemplate | string | no | Name of the group alias, which must equal the group name the identity provider sends in its groups claim; maps to the alias `name`. {role} is replaced by the role name and {org} by the organization; it must contain {role}, and {org} exactly when organizations are set. Default: "{role}", or "{org}_{role}" when organizations are set. Example: vault-{org}-{role} | Constraintspattern:^([A-Za-z0-9._-]|\{role\}|\{org\})+$length: >=1, <=128 | |
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.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.organizations | []string | no | When set, every role is repeated once per organization: {org} in paths and in groupAliasTemplate takes each value. Required 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.paths | []object | yes | Secret paths on KV version 2 mounts that each role's level applies to, 1 to 8 entries. {sa.namespace} and {sa.name} are not allowed here (they only exist for ServiceAccount logins). | Constraintsitems: >=1, <=8 | |
spec.paths[] | object | no | A pair of secret paths on a KV version 2 mount: one for secret data and one for secret metadata. A path is a list of segments separated by "/". A segment is a literal of letters, digits, ".", "_" and "-", or "+" (exactly one segment), or one of the tokens {org}, {sa.namespace} and {sa.name}. The last segment may also be "*" or end with "*" (any suffix). A token always fills a whole segment, and "." and ".." are not segments. | ||
spec.paths[].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.paths[].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.paths[].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.roles | []object | yes | The access matrix: for each role, its level per OpenBao namespace, 1 to 16 roles keyed by name. | Constraintsitems: >=1, <=16list type: map (keys: name) | |
spec.roles[] | object | no | One row of the layout matrix: a role of people and its level in each OpenBao namespace. | ||
spec.roles[].levels | []object | no | Level of the role in each OpenBao namespace, at most 32 entries keyed by namespace. A namespace that is not listed gets nothing for this role. | Constraintsitems: <=32list type: map (keys: namespace) | |
spec.roles[].levels[] | object | no | The level a role gets in one OpenBao namespace. | ||
spec.roles[].levels[].level | string | yes | Name of the AccessLevel, in the same Kubernetes namespace, granted on spec.paths in this OpenBao namespace. Example: writer | Constraintslength: >=1, <=253 | |
spec.roles[].levels[].namespace | string | no | "" | OpenBao namespace, relative to spec.namespace; empty (default) means spec.namespace itself. Each namespace may appear once per role, and must have every auth method in spec.authMounts. Example: team-a | Constraintspattern:^([A-Za-z0-9_-]+(/[A-Za-z0-9_-]+)*)?$length: <=255 |
spec.roles[].name | string | yes | Name of the role: lowercase letters, digits and "-", starting with a letter, at most 32 characters. It is part of the policy and group names and replaces {role} in the group alias. Example: developer | Constraintspattern:^[a-z][a-z0-9-]{0,31}$length: >=1, <=32 | |
status | object | no | Observed state reported by the operator: conditions 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 layout owns: its ACL policies and external groups with their aliases. With deletionPolicy Delete, deleting the layout 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.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. |