Skip to content

Identity resources · Kind catalogue · Examples

GroupMembership

API version: identity.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: groupmemberships.identity.openbaoconfig.io
Categories: openbao

GroupMembership adds entities or subgroups to an internal OpenBao group (`member_entity_ids`, `member_group_ids` of `identity/group/id/<id>`). Several may select the same member: it stays while any of them selects it. External groups take no memberships. With deletionPolicy Delete, deletion removes only the members it added.

Example:

spec:
  connectionRef:
    name: openbao
  groupRef:
    name: billing-admins
  entityRef:
    name: alice

Example

examples/identity/groupmembership.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
  name: obco-developers-platform
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  driftInterval: 30m
  managementPolicy: Manage
  groupRef:
    name: obco-developers
  entitySelector:
    matchLabels:
      obco.example.com/oncall: "true"
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
  name: obco-developers-alice
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  groupName: obco-developers
  entityRef:
    name: obco-alice
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
  name: obco-developers-bob
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  groupSelector:
    matchLabels:
      obco.example.com/role: developers
  entityName: obco-bob
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
  name: obco-developers-legacy
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  groupID: 6f1e3c2a-0000-4000-8000-000000000002
  entityID: 6f1e3c2a-0000-4000-8000-000000000001
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
  name: obco-developers-operators
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  groupRef:
    name: obco-developers
  memberGroupRef:
    name: obco-operators
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
  name: obco-developers-nested
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  groupRef:
    name: obco-developers
  memberGroupName: obco-reviewers
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
  name: obco-developers-selected-groups
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  groupRef:
    name: obco-developers
  memberGroupSelector:
    matchLabels:
      obco.example.com/nested-in: developers
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
  name: obco-developers-legacy-group
  namespace: openbao-config
spec:
  connectionRef:
    name: openbao
  groupRef:
    name: obco-developers
  memberGroupID: 6f1e3c2a-0000-4000-8000-000000000004

On GitHub: groupmembership.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
specobjectyesspec selects one internal group and one member (entity or group) source. Each GroupMembership adds and removes only the members it selects; members added in any other way are left alone. Set exactly one group field and exactly one member field.
ConstraintsCEL: [has(self.groupID), has(self.groupName), has(self.groupRef), has(self.groupSelector)].filter(x, x).size() == 1 (set exactly one of groupID, groupName, groupRef and groupSelector)
CEL: has(self.groupID) == has(oldSelf.groupID) && (!has(self.groupID) || self.groupID == oldSelf.groupID) && has(self.groupName) == has(oldSelf.groupName) && (!has(self.groupName) || self.groupName == oldSelf.groupName) && has(self.groupRef) == has(oldSelf.groupRef) && (!has(self.groupRef) || self.groupRef == oldSelf.groupRef) && has(self.groupSelector) == has(oldSelf.groupSelector) && (!has(self.groupSelector) || self.groupSelector == oldSelf.groupSelector) (the group reference is immutable)
CEL: [has(self.entityID), has(self.entityName), has(self.entityRef), has(self.entitySelector), has(self.memberGroupID), has(self.memberGroupName), has(self.memberGroupRef), has(self.memberGroupSelector)].filter(x, x).size() == 1 (set exactly one of entityID, entityName, entityRef, entitySelector, memberGroupID, memberGroupName, memberGroupRef and memberGroupSelector)
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.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.entityIDstringnoentityID is the OpenBao ID of an entity to add (`member_entity_ids`). Example: `0b1c6a2e-5d1f-4a7e-9b2e-3c4d5e6f7a8b`.
Constraintslength: >=1, <=128
spec.entityNamestringnoentityName is the name of an entity in OpenBao to add; its ID is looked up by name. Example: `alice`.
Constraintspattern: ^[^/\s]+$
length: >=1, <=256
spec.entityRefobjectnoentityRef names an Entity in this namespace to add; the entity ID is taken from its status. Example: `{name: alice}`.
spec.entityRef.namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
spec.entitySelectorobjectnoentitySelector adds every Entity in this namespace that carries these labels.
spec.entitySelector.matchLabelsmap[string]stringyesLabels an object must carry, all of them, to be selected. Example: {team: payments}
Constraintsproperties: >=1, <=16
CEL: self.all(k, size(k) <= 317 && size(self[k]) <= 63) (label keys must be at most 317 and values at most 63 characters)
spec.groupIDstringnogroupID is the OpenBao ID of the internal group. Immutable. Example: `5f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f`.
Constraintslength: >=1, <=128
spec.groupNamestringnogroupName is the name of the internal group in OpenBao; its ID is looked up by name. Immutable. Example: `billing-admins`.
Constraintspattern: ^[^/\s]+$
length: >=1, <=256
spec.groupRefobjectnogroupRef names a Group in this namespace; the group ID is taken from its status. Immutable. Example: `{name: billing-admins}`.
spec.groupRef.namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
spec.groupSelectorobjectnogroupSelector selects exactly one Group in this namespace by its labels; the group ID is taken from its status. Immutable.
spec.groupSelector.matchLabelsmap[string]stringyesLabels an object must carry, all of them, to be selected. Example: {team: payments}
Constraintsproperties: >=1, <=16
CEL: self.all(k, size(k) <= 317 && size(self[k]) <= 63) (label keys must be at most 317 and values at most 63 characters)
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.memberGroupIDstringnomemberGroupID is the OpenBao ID of a group to add as a subgroup (`member_group_ids`). Example: `7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d`.
Constraintslength: >=1, <=128
spec.memberGroupNamestringnomemberGroupName is the name of a group in OpenBao to add as a subgroup; its ID is looked up by name. Example: `billing-oncall`.
Constraintspattern: ^[^/\s]+$
length: >=1, <=256
spec.memberGroupRefobjectnomemberGroupRef names a Group in this namespace to add as a subgroup; the group ID is taken from its status. Example: `{name: billing-oncall}`.
spec.memberGroupRef.namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
spec.memberGroupSelectorobjectnomemberGroupSelector adds every Group in this namespace that carries these labels as a subgroup.
spec.memberGroupSelector.matchLabelsmap[string]stringyesLabels an object must carry, all of them, to be selected. Example: {team: payments}
Constraintsproperties: >=1, <=16
CEL: self.all(k, size(k) <= 317 && size(self[k]) <= 63) (label keys must be at most 317 and values at most 63 characters)
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
statusobjectnostatus is the observed state of the membership: the members it added, so that only those are removed later.
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.groupIDstringnogroupID is the OpenBao ID of the group the members were added to.
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.memberEntityIDs[]stringnomemberEntityIDs are the entity IDs this resource added to the group.
status.memberGroupIDs[]stringnomemberGroupIDs are the subgroup IDs this resource added to the group.
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.