Identity resources · Kind catalogue · Examples
GroupAlias¶
API version: identity.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: groupaliases.identity.openbaoconfig.io
Categories: openbao
GroupAlias links a group of an identity provider to an external OpenBao group (`identity/group-alias`). Use it so that users whose login reports that group (for example in the OIDC groups claim) become members of the external group and get its policies. A group has at most one alias.
Example:
Example:
spec:
connectionRef:
name: openbao
aliasName: billing-admins
mountPath: oidc
groupRef:
name: billing-adminsExample¶
examples/identity/groupalias.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupAlias
metadata:
name: obco-keycloak-admins
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
aliasName: /obco/admins
mountPath: oidc
groupRef:
name: obco-keycloak-admins
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupAlias
metadata:
name: obco-keycloak-auditors
namespace: openbao-config
spec:
connectionRef:
name: openbao
aliasName: /obco/auditors
mountRef:
name: obco-oidc
groupName: obco-keycloak-auditors
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupAlias
metadata:
name: obco-keycloak-viewers
namespace: openbao-config
spec:
connectionRef:
name: openbao
aliasName: /obco/viewers
mountSelector:
matchLabels:
obco.example.com/auth: oidc
groupSelector:
matchLabels:
obco.example.com/idp: keycloak-viewers
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupAlias
metadata:
name: obco-keycloak-legacy
namespace: openbao-config
spec:
connectionRef:
name: openbao
aliasName: /obco/legacy
mountAccessor: auth_oidc_0a1b2c3d
groupID: 6f1e3c2a-0000-4000-8000-000000000003
On GitHub: groupalias.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 | spec is the desired group alias: the link between a group name reported by an auth method (for example a Keycloak group in the OIDC groups claim) and an external group. OpenBao identifies the alias by the auth mount accessor and the alias name. Set exactly one of mountAccessor, mountPath, mountRef and mountSelector, and exactly one of groupID, groupName, groupRef and groupSelector. | ConstraintsCEL:self.aliasName == oldSelf.aliasName (aliasName is immutable)CEL: [has(self.mountAccessor), has(self.mountPath), has(self.mountRef), has(self.mountSelector)].filter(x, x).size() == 1 (set exactly one of mountAccessor, mountPath, mountRef and mountSelector)CEL: has(self.mountAccessor) == has(oldSelf.mountAccessor) && (!has(self.mountAccessor) || self.mountAccessor == oldSelf.mountAccessor) && has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) && has(self.mountRef) == has(oldSelf.mountRef) && (!has(self.mountRef) || self.mountRef == oldSelf.mountRef) && has(self.mountSelector) == has(oldSelf.mountSelector) && (!has(self.mountSelector) || self.mountSelector == oldSelf.mountSelector) (the auth mount reference is immutable)CEL: [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.__namespace__) == has(oldSelf.__namespace__) && (!has(self.__namespace__) || self.__namespace__ == oldSelf.__namespace__) (namespace is immutable)CEL: self.connectionRef == oldSelf.connectionRef (connectionRef is immutable) | |
spec.aliasName | string | yes | aliasName is the group name the auth method reports at login (`name`). Immutable. Example: `billing-admins`. | Constraintslength: >=1, <=512 | |
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.groupID | string | no | groupID is the OpenBao ID of the external group the alias belongs to (`canonical_id`). Example: `5f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f`. | Constraintslength: >=1, <=128 | |
spec.groupName | string | no | groupName is the name of the external group in OpenBao; its ID is looked up by name. Example: `billing-admins`. | Constraintspattern:^[^/\s]+$length: >=1, <=256 | |
spec.groupRef | object | no | groupRef names a Group of type external in this namespace; the group ID is taken from its status. Example: `{name: billing-admins}`. | ||
spec.groupRef.name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
spec.groupSelector | object | no | groupSelector selects exactly one Group of type external in this namespace by its labels; the group ID is taken from its status. | ||
spec.groupSelector.matchLabels | map[string]string | yes | Labels an object must carry, all of them, to be selected. Example: {team: payments} | Constraintsproperties: >=1, <=16CEL: self.all(k, size(k) <= 317 && size(self[k]) <= 63) (label keys must be at most 317 and values at most 63 characters) | |
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 | mountAccessor is the accessor of the auth mount (`mount_accessor`). Immutable. Example: `auth_oidc_1a2b3c4d`. | Constraintslength: >=1, <=128 | |
spec.mountPath | string | no | mountPath is the path of the auth mount without the `auth/` prefix; its accessor is looked up in `sys/auth`, which needs read access there. Immutable. Example: `oidc`. | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: <=128 | |
spec.mountRef | object | no | mountRef names an AuthMount in this namespace; its accessor is taken from the AuthMount status. Immutable. Example: `{name: oidc}`. | ||
spec.mountRef.name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
spec.mountSelector | object | no | mountSelector selects exactly one AuthMount in this namespace by its labels; its accessor is taken from the AuthMount status. Immutable. | ||
spec.mountSelector.matchLabels | map[string]string | yes | Labels an object must carry, all of them, to be selected. Example: {team: payments} | Constraintsproperties: >=1, <=16CEL: self.all(k, size(k) <= 317 && size(self[k]) <= 63) (label keys must be at most 317 and values at most 63 characters) | |
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 | |
status | object | no | status is the observed state of the group alias; `id` holds the OpenBao alias ID. | ||
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.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. |