Skip to content

Access resources · Kind catalogue · Examples

AccessLevel

API version: access.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: accesslevels.access.openbaoconfig.io
Categories: openbao

AccessLevel is a named, reusable set of ACL capabilities on KV version 2 secret data and metadata, such as reader, writer or owner. It writes nothing to OpenBao by itself: AccessGrant rules and AccessLayout roles in the same Kubernetes namespace cite it by name and render it into their policies. The openbaoconfig.io/in-use finalizer keeps it while anything cites it.

Example:

spec:
  data: [read, list]
  metadata: [read, list]
  versions: false

Example

examples/access/accesslevel.yaml
# Reusable capability sets on KV data and metadata (read, write, owner) that AccessGrant and AccessLayout rules name.
apiVersion: access.openbaoconfig.io/v1alpha1
kind: AccessLevel
metadata:
  name: read
  namespace: openbao-config
spec:
  data:
    - read
  metadata:
    - read
    - list
---
apiVersion: access.openbaoconfig.io/v1alpha1
kind: AccessLevel
metadata:
  name: write
  namespace: openbao-config
spec:
  data:
    - create
    - read
    - update
    - patch
  metadata:
    - read
    - list
---
apiVersion: access.openbaoconfig.io/v1alpha1
kind: AccessLevel
metadata:
  name: owner
  namespace: openbao-config
spec:
  data:
    - create
    - read
    - update
    - patch
    - delete
    - list
  metadata:
    - create
    - read
    - update
    - patch
    - delete
    - list
  versions: true

On GitHub: accesslevel.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: the capabilities this level grants wherever it is cited.
ConstraintsCEL: (has(self.data) && size(self.data) > 0) || (has(self.metadata) && size(self.metadata) > 0) || (has(self.versions) && self.versions) (set at least one of data, metadata and versions)
spec.data[]stringnoACL capabilities granted on secret data, the policy path <mount>/data/<path>. Allowed: create, read, update, patch, delete, list. Example: [read, list]
Constraintsitems: <=6
list type: set
each item: one of: create, read, update, patch, delete, list
spec.metadata[]stringnoACL capabilities granted on secret metadata, the policy path <mount>/metadata/<metadataPath> (listing keys and reading versions need list and read here). Allowed: create, read, update, patch, delete, list. Example: [list]
Constraintsitems: <=6
list type: set
each item: one of: create, read, update, patch, delete, list
spec.versionsbooleannoWhen true, also grants update on <mount>/delete/<path>, <mount>/undelete/<path> and <mount>/destroy/<path>, which soft-delete, restore and permanently destroy individual secret versions. Default: false. At least one of data, metadata and versions must be set. Example: true
statusobjectnoObserved state reported by the operator: conditions and the resources that cite this level.
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.citedBy[]stringnoAccessGrant and AccessLayout resources that cite this level, as <kind>/<name>. While the list is not empty, the openbaoconfig.io/in-use finalizer holds a deletion of the level. Example: AccessGrant/app-reader
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.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.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.