Skip to content

System resources · Kind catalogue · Examples

Policy

API version: sys.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: policies.sys.openbaoconfig.io
Categories: openbao

Policy manages an OpenBao ACL policy at sys/policies/acl/<name>, which grants capabilities on paths to the tokens it is attached to. The root and response-wrapping policies cannot be managed, and the default policy only with deletionPolicy Orphan. deletionPolicy defaults to Orphan; Delete removes the policy.

Example:

spec:
  connectionRef:
    name: openbao
  name: app-read
  policy: |
    path "secret/data/app/*" {
      capabilities = ["read"]
    }

Example

examples/sys/policy.yaml
# An ACL policy for team a that reads KV secrets by identity: paths are templated with entity metadata and with the
# alias of a login on a named auth mount, whose accessor the operator resolves from the AuthMount resources.
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Policy
metadata:
  name: obco-team-a-reader
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  driftInterval: 15m
  managementPolicy: Manage
  name: team-a-reader
  policy: |
    path "team-a/kv/data/{{identity.entity.metadata.app}}/*" {
      capabilities = ["read", "list"]
    }
    path "team-a/kv/data/sa/{{identity.entity.aliases.${accessor:k8s}.metadata.service_account_namespace}}/*" {
      capabilities = ["read"]
    }
    path "team-a/kv/data/ci/{{identity.entity.aliases.${accessor:ci}.name}}/*" {
      capabilities = ["read"]
    }
  accessorRefs:
    k8s:
      authMountRef:
        name: obco-kubernetes
    ci:
      authMountRef:
        name: obco-approle
  casRequired: false
  allowWildcardsInIdentityTemplates: false
  allowSlashesInIdentityTemplates: true

On GitHub: policy.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.

Object validation:
CEL: !((has(self.spec.name) ? self.spec.name : self.metadata.name) in ['root', 'response-wrapping']) (the root and response-wrapping policies cannot be changed)
CEL: (has(self.spec.name) ? self.spec.name : self.metadata.name) != 'default' || (has(self.spec.deletionPolicy) && self.spec.deletionPolicy == 'Orphan') (the default policy cannot be deleted; set deletionPolicy to Orphan)
FieldTypeRequiredDefaultDescriptionValidation
specobjectyesDesired state of the OpenBao ACL policy.
ConstraintsCEL: has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name 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.accessorRefsmap[string]objectnoAuth mounts whose accessors the policy uses, by placeholder name: `${accessor:<name>}` in policy becomes the accessor of the mount. The policy is rewritten when the mount is recreated with a new accessor, and waits while a mount is missing. At most 16 entries; names are 1-63 characters of [a-z0-9_-]. Example: {k8s: {authMountRef: {name: kubernetes}}}
Constraintsproperties: <=16
CEL: self.all(k, k.matches('^[a-z0-9_-]{1,63}$')) (accessorRefs names are 1-63 characters of [a-z0-9_-])
spec.accessorRefs.<key>objectnoThe auth mount whose accessor replaces one placeholder. Set exactly one field.
ConstraintsCEL: [has(self.authMountRef),has(self.mountPath)].filter(x,x==true).size() == 1 (exactly one of the fields in [authMountRef mountPath] must be set)
spec.accessorRefs.<key>.authMountRefobjectnoAuthMount in this namespace; its accessor is taken from the AuthMount status. Example: {name: kubernetes}
spec.accessorRefs.<key>.authMountRef.namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
spec.accessorRefs.<key>.mountPathstringnoPath of the auth mount in the policy's OpenBao namespace, without the auth/ prefix; its accessor is read from sys/auth. Example: kubernetes
Constraintspattern: ^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$
length: <=256
spec.allowSlashesInIdentityTemplatesbooleannoWhether identity templates in path names may expand to values that contain a slash, which is blocked by default because it adds path segments. Maps to `allow_slashes_in_identity_templates`. Default: false. Example: false
spec.allowWildcardsInIdentityTemplatesbooleannoWhether identity templates in path names may expand to values that contain the glob characters * and +, which would otherwise make the path match more than intended. Maps to `allow_wildcards_in_identity_templates`. Default: false. Example: false
spec.casRequiredbooleannoWhether every change of the policy must pass the current version as check-and-set value; the operator sends it on each write. Maps to `cas_required`. Default: false. Example: true
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.namestringnoName of the policy, the <name> in sys/policies/acl/<name>. Default: metadata.name. OpenBao lowercases and path-cleans policy names, so the name must be lowercase, without whitespace, and without a leading or trailing slash or an empty, "." or ".." segment. root and response-wrapping cannot be managed. Immutable. Example: app-read
Constraintspattern: ^([^/.\s\p{Lu}][^/\s\p{Lu}]*|\.[^/.\s\p{Lu}][^/\s\p{Lu}]*|\.\.[^/\s\p{Lu}]+)(/([^/.\s\p{Lu}][^/\s\p{Lu}]*|\.[^/.\s\p{Lu}][^/\s\p{Lu}]*|\.\.[^/\s\p{Lu}]+))*$
length: >=1, <=256
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.policystringyesACL policy document in HCL or JSON. Maps to `policy`. `${accessor:<name>}` is replaced by the accessor of the auth mount that accessorRefs names; OpenBao `{{identity...}}` templates are sent unchanged. Example: path "secret/data/app/*" { capabilities = ["read"] }
Constraintslength: >=1
statusobjectnoObserved state reported by the operator: conditions, OpenBao path and ownership.
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.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.