identity.openbaoconfig.io examples¶
Each kind shows its curated example first, then any variants, then the generated sample with every spec field set. The fields are described in the API reference.
Entity¶
Identity entities for two people, with policies and metadata; logins are linked to them by EntityAlias resources.
# Identity entities for two people, with policies and metadata; logins are linked to them by EntityAlias resources.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: Entity
metadata:
name: obco-alice
namespace: openbao-config
labels:
obco.example.com/team: platform
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
name: obco-alice
policies:
- obco-reader
- obco-writer
metadata:
team: platform
email: alice@example.com
disabled: false
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: Entity
metadata:
name: obco-bob
namespace: openbao-config
labels:
obco.example.com/team: platform
spec:
connectionRef:
name: openbao
policies:
- obco-reader
# Entity (identity.openbaoconfig.io/v1alpha1)
# Entity manages an OpenBao identity entity (one person or workload) at `identity/entity/name/<name>`.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#entity
# Curated example: examples/identity/entity.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: Entity
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
disabled: true
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
metadata:
example: example
name: example
namespace: example
policies:
- default
EntityAlias¶
EntityAlias links a login on an auth mount to an OpenBao identity entity (identity/entity-alias).
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: EntityAlias
metadata:
name: obco-alice-approle
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
aliasName: obco-alice-ci
mountRef:
name: obco-approle
entityRef:
name: obco-alice
customMetadata:
source: gitops
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: EntityAlias
metadata:
name: obco-bob-approle
namespace: openbao-config
spec:
connectionRef:
name: openbao
aliasName: obco-bob-ci
mountPath: approle-ci
entityName: obco-bob
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: EntityAlias
metadata:
name: obco-platform-approle
namespace: openbao-config
spec:
connectionRef:
name: openbao
aliasName: obco-platform-ci
mountSelector:
matchLabels:
obco.example.com/auth: approle
entitySelector:
matchLabels:
obco.example.com/service: platform-ci
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: EntityAlias
metadata:
name: obco-legacy-approle
namespace: openbao-config
spec:
connectionRef:
name: openbao
aliasName: obco-legacy-ci
mountAccessor: auth_approle_0a1b2c3d
entityID: 6f1e3c2a-0000-4000-8000-000000000001
# EntityAlias (identity.openbaoconfig.io/v1alpha1)
# EntityAlias links a login on an auth mount to an OpenBao identity entity (`identity/entity-alias`).
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: aliasName, connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#entityalias
# Curated example: examples/identity/entityalias.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: EntityAlias
metadata:
name: example
namespace: openbao-config
spec:
aliasName: example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
customMetadata:
example: example
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
entityID: example
managementPolicy: Manage
mountAccessor: example
namespace: example
Group¶
Internal identity groups that grant policies to their members (added with GroupMembership), plus an external group for an identity provider group.
# Internal identity groups that grant policies to their members (added with GroupMembership), plus an external
# group for an identity provider group.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: Group
metadata:
name: obco-developers
namespace: openbao-config
labels:
obco.example.com/role: developers
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
name: obco-developers
type: internal
policies:
- obco-reader
- obco-writer
metadata:
owner: platform
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: Group
metadata:
name: obco-operators
namespace: openbao-config
spec:
connectionRef:
name: openbao
type: internal
policies:
- obco-reader
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: Group
metadata:
name: obco-keycloak-admins
namespace: openbao-config
labels:
obco.example.com/idp: keycloak
spec:
connectionRef:
name: openbao
type: external
policies:
- obco-admin
# Group (identity.openbaoconfig.io/v1alpha1)
# Group manages an OpenBao identity group at `identity/group/name/<name>`, which grants policies to its members.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#group
# Curated example: examples/identity/group.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: Group
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
metadata:
example: example
name: example
namespace: example
policies:
- default
type: internal
GroupAlias¶
GroupAlias links a group of an identity provider to an external OpenBao group (identity/group-alias).
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
# GroupAlias (identity.openbaoconfig.io/v1alpha1)
# GroupAlias links a group of an identity provider to an external OpenBao group (`identity/group-alias`).
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: aliasName, connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#groupalias
# Curated example: examples/identity/groupalias.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupAlias
metadata:
name: example
namespace: openbao-config
spec:
aliasName: example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
groupID: example
managementPolicy: Manage
mountAccessor: example
namespace: example
GroupMembership¶
GroupMembership adds entities or subgroups to an internal OpenBao group (member_entity_ids, member_group_ids of identity/group/id/<id>).
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
# GroupMembership (identity.openbaoconfig.io/v1alpha1)
# GroupMembership adds entities or subgroups to an internal OpenBao group (`member_entity_ids`, `member_group_ids` of
# `identity/group/id/<id>`).
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#groupmembership
# Curated example: examples/identity/groupmembership.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: GroupMembership
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
entityID: example
groupID: example
managementPolicy: Manage
namespace: example
MFALoginEnforcement¶
MFALoginEnforcement requires login MFA at identity/mfa/login-enforcement/<name> for the selected auth mounts, auth method types, entities or groups.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFALoginEnforcement
metadata:
name: obco-admins-mfa
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Delete
name: obco-admins-mfa
mfaMethods:
- methodRef:
name: obco-totp
- methodName: obco-duo
- methodID: 6f1e3c2a-0000-4000-8000-000000000003
- methodSelector:
matchLabels:
obco.example.com/mfa: required
authMounts:
- mountPath: userpass
- mountRef:
name: obco-oidc
- mountAccessor: auth_userpass_0000fake
- mountSelector:
matchLabels:
obco.example.com/mfa: required
authMethodTypes:
- userpass
entities:
- entityID: 6f1e3c2a-0000-4000-8000-000000000001
- entityName: obco-alice
- entityRef:
name: obco-bob
- entitySelector:
matchLabels:
obco.example.com/mfa: required
groups:
- groupID: 6f1e3c2a-0000-4000-8000-000000000002
- groupName: obco-admins
- groupRef:
name: obco-operators
- groupSelector:
matchLabels:
obco.example.com/mfa: required
# MFALoginEnforcement (identity.openbaoconfig.io/v1alpha1)
# MFALoginEnforcement requires login MFA at `identity/mfa/login-enforcement/<name>` for the selected auth mounts, auth
# method types, entities or groups.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef, mfaMethods.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#mfaloginenforcement
# Curated example: examples/identity/mfaloginenforcement.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFALoginEnforcement
metadata:
name: example
namespace: openbao-config
spec:
authMethodTypes:
- example
authMounts:
- mountAccessor: example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
entities:
- entityID: example
groups:
- groupID: example
managementPolicy: Manage
mfaMethods:
- methodID: example
name: example
namespace: example
MFAMethod¶
MFAMethod manages a login MFA method (TOTP, Duo, Okta or PingID) at identity/mfa/method/<type>/<id>.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
name: obco-totp
namespace: openbao-config
labels:
obco.example.com/mfa: required
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Orphan
name: obco-totp
totp:
issuer: OBCO Sandbox
period: 30s
keySize: 20
qrSize: 200
algorithm: SHA256
digits: 6
skew: 1
maxValidationAttempts: 5
---
apiVersion: v1
kind: Secret
metadata:
name: obco-duo-credentials
namespace: openbao-config
type: Opaque
stringData:
secret-key: fake-duo-secret-key-not-real
integration-key: FAKEDUOINTEGRATIONKEY
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
name: obco-duo
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Orphan
name: obco-duo
duo:
secretKeySecretRef:
name: obco-duo-credentials
key: secret-key
integrationKeySecretRef:
name: obco-duo-credentials
key: integration-key
apiHostname: api-fake0000.duosecurity.com
pushInfo: from=openbao&env=sandbox
usePasscode: true
usernameFormat: "{{alias.name}}"
---
apiVersion: v1
kind: Secret
metadata:
name: obco-okta-credentials
namespace: openbao-config
type: Opaque
stringData:
api-token: fake-okta-api-token-not-real
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
name: obco-okta
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Orphan
name: obco-okta
okta:
orgName: obco-fake
apiTokenSecretRef:
name: obco-okta-credentials
key: api-token
baseURL: oktapreview.com
primaryEmail: true
usernameFormat: "{{entity.name}}@obco.example.com"
---
apiVersion: v1
kind: Secret
metadata:
name: obco-pingid-settings
namespace: openbao-config
type: Opaque
stringData:
pingid.properties: |
use_base64_key=ZmFrZS1rZXk=
use_signature=true
token=fake-token
idp_url=https://idpxnyl3m.pingidentity.com/pingid
org_alias=fake-org-alias
admin_url=https://idpxnyl3m.pingidentity.com/pingid
authenticator_url=https://authenticator.pingone.com/pingid/ppm
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
name: obco-pingid
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Orphan
name: obco-pingid
pingID:
settingsFileSecretRef:
name: obco-pingid-settings
key: pingid.properties
usernameFormat: "{{alias.name}}"
# MFAMethod (identity.openbaoconfig.io/v1alpha1)
# MFAMethod manages a login MFA method (TOTP, Duo, Okta or PingID) at `identity/mfa/method/<type>/<id>`.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#mfamethod
# Curated example: examples/identity/mfamethod.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
name: example
namespace: example
totp:
algorithm: SHA1
digits: 6
issuer: https://openbao.example.com:8200
keySize: 1
maxValidationAttempts: 1
period: 1h
qrSize: 1
skew: 1
OIDCAssignment¶
OIDCAssignment manages an assignment of the OpenBao OIDC provider at identity/oidc/assignment/<name>: the entities and groups allowed to log in to the OIDCClient objects that list it in assignments.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCAssignment
metadata:
name: obco-portal-users
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Delete
name: obco-portal-users
entities:
- entityID: 6f1e3c2a-0000-4000-8000-000000000001
- entityName: obco-alice
- entityRef:
name: obco-bob
- entitySelector:
matchLabels:
obco.example.com/portal: "true"
groups:
- groupID: 6f1e3c2a-0000-4000-8000-000000000002
- groupName: obco-developers
- groupRef:
name: obco-operators
- groupSelector:
matchLabels:
obco.example.com/portal: "true"
# OIDCAssignment (identity.openbaoconfig.io/v1alpha1)
# OIDCAssignment manages an assignment of the OpenBao OIDC provider at `identity/oidc/assignment/<name>`: the entities
# and groups allowed to log in to the OIDCClient objects that list it in assignments.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#oidcassignment
# Curated example: examples/identity/oidcassignment.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCAssignment
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
entities:
- entityID: example
groups:
- groupID: example
managementPolicy: Manage
name: example
namespace: example
OIDCClient¶
OIDCClient manages an application that logs users in through the OpenBao OIDC provider, at identity/oidc/client/<name>.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCClient
metadata:
name: obco-portal
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Delete
name: obco-portal
key: obco-signing-key
clientType: confidential
redirectURIs:
- https://portal.obco.example.com/oidc/callback
- http://localhost:8250/oidc/callback
assignments:
- obco-portal-users
idTokenTTL: 30m
accessTokenTTL: 1h
authorizationCode: true
clientCredentials: true
writeSecretRef:
name: obco-portal-oidc-credentials
# OIDCClient (identity.openbaoconfig.io/v1alpha1)
# OIDCClient manages an application that logs users in through the OpenBao OIDC provider, at
# `identity/oidc/client/<name>`.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#oidcclient
# Curated example: examples/identity/oidcclient.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCClient
metadata:
name: example
namespace: openbao-config
spec:
accessTokenTTL: 1h
assignments:
- example
authorizationCode: true
clientCredentials: true
clientType: confidential
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
idTokenTTL: 1h
key: default
managementPolicy: Manage
name: example
namespace: example
redirectURIs:
- https://openbao.example.com:8200
writeSecretRef:
name: oidcclient-write-secret-ref
OIDCConfig¶
OIDCConfig sets the identity token (OIDC) configuration of an OpenBao namespace at identity/oidc/config, a singleton.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCConfig
metadata:
name: obco-oidc-config
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Orphan
issuer: https://openbao.obco.example.com:8200
# OIDCConfig (identity.openbaoconfig.io/v1alpha1)
# OIDCConfig sets the identity token (OIDC) configuration of an OpenBao namespace at `identity/oidc/config`, a
# singleton.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef, issuer.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#oidcconfig
# Curated example: examples/identity/oidcconfig.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCConfig
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
issuer: https://openbao.example.com:8200
managementPolicy: Manage
namespace: example
OIDCKey¶
OIDCKey manages a named key at identity/oidc/key/<name> that signs OpenBao identity tokens and OIDC provider tokens.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCKey
metadata:
name: obco-signing-key
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Delete
name: obco-signing-key
rotationPeriod: 24h
verificationTTL: 48h
algorithm: ES256
allowedClientIDs:
- "*"
# OIDCKey (identity.openbaoconfig.io/v1alpha1)
# OIDCKey manages a named key at `identity/oidc/key/<name>` that signs OpenBao identity tokens and OIDC provider
# tokens.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#oidckey
# Curated example: examples/identity/oidckey.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCKey
metadata:
name: example
namespace: openbao-config
spec:
algorithm: RS256
allowedClientIDs:
- example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
name: example
namespace: example
rotationPeriod: 1h
verificationTTL: 1h
OIDCProvider¶
OIDCProvider manages an OpenID Connect provider served by OpenBao at identity/oidc/provider/<name>.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCProvider
metadata:
name: obco-provider
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Delete
name: obco-provider
issuer: https://openbao.obco.example.com:8200
allowedClients:
- clientRef:
name: obco-portal
- clientName: obco-cli
- clientID: obcoStaticClientId0000000000000
- clientSelector:
matchLabels:
obco.example.com/provider: obco-provider
scopesSupported:
- obco-groups
# OIDCProvider (identity.openbaoconfig.io/v1alpha1)
# OIDCProvider manages an OpenID Connect provider served by OpenBao at `identity/oidc/provider/<name>`.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#oidcprovider
# Curated example: examples/identity/oidcprovider.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCProvider
metadata:
name: example
namespace: openbao-config
spec:
allowedClients:
- clientID: example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
issuer: https://openbao.example.com:8200
managementPolicy: Manage
name: example
namespace: example
scopesSupported:
- example
OIDCRole¶
OIDCRole manages a role at identity/oidc/role/<name> that OpenBao identity tokens are issued against (identity/oidc/token/<name>).
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCRole
metadata:
name: obco-workload-token
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Delete
name: obco-workload-token
key: obco-signing-key
template: '{"team": {{identity.entity.metadata.team}}, "groups": {{identity.entity.groups.names}}}'
ttl: 1h
clientID: obco-workload-audience
# OIDCRole (identity.openbaoconfig.io/v1alpha1)
# OIDCRole manages a role at `identity/oidc/role/<name>` that OpenBao identity tokens are issued against
# (`identity/oidc/token/<name>`).
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef, key.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#oidcrole
# Curated example: examples/identity/oidcrole.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCRole
metadata:
name: example
namespace: openbao-config
spec:
clientID: example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
key: example
managementPolicy: Manage
name: example
namespace: example
template: '{'
ttl: 1h
OIDCScope¶
OIDCScope manages a scope of the OpenBao OIDC provider at identity/oidc/scope/<name>: a template of claims added to ID tokens when a client requests the scope.
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCScope
metadata:
name: obco-groups
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
driftDetection: Enabled
driftInterval: 30m
managementPolicy: Manage
deletionPolicy: Delete
name: obco-groups
template: '{"groups": {{identity.entity.groups.names}}}'
description: Group names of the authenticated entity
# OIDCScope (identity.openbaoconfig.io/v1alpha1)
# OIDCScope manages a scope of the OpenBao OIDC provider at `identity/oidc/scope/<name>`: a template of claims added
# to ID tokens when a client requests the scope.
#
# Generated from the CRD by hack/samplegen (make samples); do not edit. Every spec field is set to a placeholder that
# passes the CRD's OpenAPI and CEL validation, so the sample shows the shape of the kind, not a working configuration.
# Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/identity/#oidcscope
# Curated example: examples/identity/oidcscope.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCScope
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
description: example
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
name: example
namespace: example
template: '{'