Examples¶
Curated examples live in examples/<group>/<kind>.yaml: realistic manifests, most with a comment that
explains the scenario. Generated samples live in examples-generated/ (make samples): one per kind, with
every spec field set to a placeholder that passes the CRD validation. CI applies both with a server-side
dry run, and each release attaches them as examples-<version>.tar.gz.
Secret inputs are always references to a Kubernetes Secret by name and key; create the Secret first.
core.openbaoconfig.io¶
| Kind | Scenario | Example | Files |
|---|---|---|---|
| ClusterOpenBaoConnection | The platform team's connection logs in to the Kubernetes auth mount as a dedicated ServiceAccount of the operator namespace, with a short-lived TokenRequest token for the openbao audience, which the OpenBao role must expect. | curated + 2 variants | clusteropenbaoconnection.yaml · clusteropenbaoconnection-filesystem.yaml · clusteropenbaoconnection-injectedidentity.yaml · generated · API |
| OpenBaoConnection | A tenant connection logs in as a ServiceAccount of its own namespace with a TokenRequest token for the OpenBao audience. | curated | openbaoconnection.yaml · generated · API |
| OpenBaoEndpoint | Manages any OpenBao path the typed kinds do not cover; here a KV v2 secrets engine mount. | curated | openbaoendpoint.yaml · generated · API |
| OpenBaoServer | The platform team declares the OpenBao server once. | curated | openbaoserver.yaml · generated · API |
sys.openbaoconfig.io¶
| Kind | Scenario | Example | Files |
|---|---|---|---|
| Audit | Audit enables an OpenBao audit device at sys/audit/<path>, in the root namespace only; every field is immutable. | curated | audit.yaml · generated · API |
| AuditRequestHeader | AuditRequestHeader makes the OpenBao audit devices record an HTTP request header, at sys/config/auditing/request-headers/<name>, in the root namespace only. | curated + 1 variant | auditrequestheader.yaml · auditrequestheader-attribution.yaml · generated · API |
| AuthMount | Enables the auth methods that the auth kinds then configure: AppRole for CI pipelines at approle-ci, with user lockout after five failed logins, plus LDAP and Kubernetes mounts. | curated | authmount.yaml · generated · API |
| CORSConfig | CORSConfig enables cross-origin (CORS) requests to OpenBao at sys/config/cors, a server-wide singleton in the root namespace. | curated | corsconfig.yaml · generated · API |
| KeyRotationConfig | KeyRotationConfig sets the automatic rotation of the barrier encryption key (the key that encrypts OpenBao storage, not a secret) at sys/rotate/config, a singleton of the root namespace or a sealable namespace. | curated | keyrotationconfig.yaml · generated · API |
| Logger | Logger sets the runtime log level of one named OpenBao logger at sys/loggers/<name>, for example to debug one subsystem without restarting the server. | curated | logger.yaml · generated · API |
| OpenBaoNamespace | Creates the OpenBao namespace team-a with custom metadata; with deletionPolicy Orphan the namespace and its contents stay when the resource is deleted. | curated | openbaonamespace.yaml · generated · API |
| PasswordPolicy | PasswordPolicy manages an OpenBao password policy at sys/policies/password/<name>: the rules secrets engines (database, LDAP and others) and RandomSecret use to generate passwords. | curated | passwordpolicy.yaml · generated · API |
| Plugin | Plugin registers an external plugin in the OpenBao plugin catalog at sys/plugins/catalog/<type>/<name>, so mounts can use it. | curated | plugin.yaml · generated · API |
| Policy | 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. | curated | policy.yaml · generated · API |
| QuotaConfig | QuotaConfig manages the server-wide rate-limit quota settings at sys/quotas/config: exempt paths, audit logging of rejections and response headers. | curated | quotaconfig.yaml · generated · API |
| RaftAutopilot | RaftAutopilot manages the raft autopilot settings at sys/storage/raft/autopilot/configuration: dead server cleanup, health thresholds and voter promotion. | curated | raftautopilot.yaml · generated · API |
| RateLimitQuota | RateLimitQuota manages an OpenBao rate limit quota at sys/quotas/rate-limit/<name>, which caps the request rate globally or for one namespace, mount, path or auth role. | curated | ratelimitquota.yaml · generated · API |
| SecretsMount | Enables a KV version 2 secrets engine at team-a/kv, plus a Nomad engine (external plugin) at nomad. | curated | secretsmount.yaml · generated · API |
| UIHeader | UIHeader manages a custom HTTP response header that OpenBao returns with its web UI, at sys/config/ui/headers/<name>, for example a Content-Security-Policy. | curated | uiheader.yaml · generated · API |
| Workflow | Workflow manages an OpenBao workflow at sys/workflows/manage/<path>: a declarative sequence of API requests (a profile) that callers run through sys/workflows/execute/<path>. | curated | workflow.yaml · generated · API |
auth.openbaoconfig.io¶
| Kind | Scenario | Example | Files |
|---|---|---|---|
| AWSAuthCertificate | AWSAuthCertificate manages an AWS public certificate of an OpenBao AWS auth method at auth/<mountPath>/config/certificate/<name>. | curated | awsauthcertificate.yaml · generated · API |
| AWSAuthConfig | AWSAuthConfig manages the AWS client configuration of an OpenBao AWS auth method at auth/<mountPath>/config/client. | curated | awsauthconfig.yaml · generated · API |
| AWSAuthIdentityConfig | AWSAuthIdentityConfig manages how an OpenBao AWS auth method builds entity alias names and token metadata, at auth/<mountPath>/config/identity. | curated | awsauthidentityconfig.yaml · generated · API |
| AWSAuthRole | AWSAuthRole manages a role of an OpenBao AWS auth method at auth/<mountPath>/role/<name>. | curated | awsauthrole.yaml · generated · API |
| AWSAuthSTSRole | AWSAuthSTSRole manages the STS role an OpenBao AWS auth method assumes for one AWS account, at auth/<mountPath>/config/sts/<accountID>. | curated | awsauthstsrole.yaml · generated · API |
| AWSAuthTidyConfig | AWSAuthTidyConfig manages the periodic tidy settings of an OpenBao AWS auth method, at auth/<mountPath>/config/tidy/identity-accesslist and auth/<mountPath>/config/tidy/roletag-denylist. | curated | awsauthtidyconfig.yaml · generated · API |
| AppRole | An AppRole role for a CI deployer outside Kubernetes: a fixed role ID, secret IDs bound to a CIDR and valid for a day, and short-lived tokens with the ci-deployer policy. | curated | approle.yaml · generated · API |
| AppRoleSecretID | AppRoleSecretID generates a secret ID for an OpenBao AppRole role at auth/<mountPath>/role/<role>/secret-id and writes it, with the role ID, to a Kubernetes Secret. | curated | approlesecretid.yaml · generated · API |
| AzureAuthConfig | AzureAuthConfig manages the configuration of an OpenBao Azure auth method at auth/<mountPath>/config. | curated | azureauthconfig.yaml · generated · API |
| AzureAuthRole | AzureAuthRole manages a role of an OpenBao Azure auth method at auth/<mountPath>/role/<name>. | curated | azureauthrole.yaml · generated · API |
| CFAuthConfig | CFAuthConfig manages the configuration of an OpenBao Cloud Foundry auth method at auth/<mountPath>/config. | curated | cfauthconfig.yaml · generated · API |
| CFAuthRole | CFAuthRole manages a role of an OpenBao Cloud Foundry auth method at auth/<mountPath>/roles/<name>. | curated | cfauthrole.yaml · generated · API |
| CertAuthCRL | CertAuthCRL installs a certificate revocation list on a TLS certificate auth method at auth/<mountPath>/crls/<name>, either as a fetched URL or as embedded PEM data. | curated | certauthcrl.yaml · generated · API |
| CertAuthConfig | CertAuthConfig manages the mount-wide settings of an OpenBao TLS certificate auth method at auth/<mountPath>/config. | curated | certauthconfig.yaml · generated · API |
| CertAuthRole | CertAuthRole manages a trusted certificate role of an OpenBao TLS certificate auth method at auth/<mountPath>/certs/<name>. | curated | certauthrole.yaml · generated · API |
| GCPAuthConfig | GCPAuthConfig manages the configuration of an OpenBao GCP auth method at auth/<mountPath>/config. | curated | gcpauthconfig.yaml · generated · API |
| GCPAuthRole | GCPAuthRole manages a role of an OpenBao GCP auth method at auth/<mountPath>/role/<name>. | curated | gcpauthrole.yaml · generated · API |
| GitHubAuthConfig | GitHubAuthConfig manages the configuration of an OpenBao GitHub auth method at auth/<mountPath>/config. | curated | githubauthconfig.yaml · generated · API |
| GitHubAuthTeam | GitHubAuthTeam manages the policy mapping of a GitHub team in an OpenBao GitHub auth method at auth/<mountPath>/map/teams/<name>. | curated | githubauthteam.yaml · generated · API |
| GitHubAuthUser | GitHubAuthUser manages the policy mapping of a GitHub user in an OpenBao GitHub auth method at auth/<mountPath>/map/users/<name>. | curated | githubauthuser.yaml · generated · API |
| JWTAuthConfig | Configures the oidc mount for browser logins through a Keycloak realm found by OIDC discovery, with the client secret read from a Secret. | curated | jwtauthconfig.yaml · generated · API |
| JWTAuthRole | Lets CI jobs of the protected main branch of platform/app log in on the jwt-ci mount with their job JWT: the subject, audience and claims are bound, and the project path and ref become token metadata. | curated | jwtauthrole.yaml · generated · API |
| JWTCELRole | JWTCELRole manages a CEL role of an OpenBao JWT auth method at auth/<mountPath>/cel/role/<name>. | curated | jwtcelrole.yaml · generated · API |
| KerberosAuthConfig | KerberosAuthConfig manages the configuration of an OpenBao Kerberos auth method at auth/<mountPath>/config. | curated | kerberosauthconfig.yaml · generated · API |
| KerberosAuthGroup | KerberosAuthGroup manages an LDAP group mapping of an OpenBao Kerberos auth method at auth/<mountPath>/groups/<name>. | curated | kerberosauthgroup.yaml · generated · API |
| KerberosAuthLDAPConfig | KerberosAuthLDAPConfig manages the LDAP configuration of an OpenBao Kerberos auth method at auth/<mountPath>/config/ldap. | curated | kerberosauthldapconfig.yaml · generated · API |
| KubernetesAuthConfig | Points the kubernetes auth mount at the cluster's API server with its CA certificate, and reads the token reviewer JWT from a Secret. | curated | kubernetesauthconfig.yaml · generated · API |
| KubernetesAuthRole | Lets pods of ServiceAccount app or app-worker in namespace team-a (or in a namespace selected by labels) log in with the openbao audience and get the app-reader policy plus the policy of a Policy resource. | curated | kubernetesauthrole.yaml · generated · API |
| LDAPAuthConfig | LDAPAuthConfig manages the configuration of an OpenBao LDAP auth method at auth/<mountPath>/config. | curated | ldapauthconfig.yaml · generated · API |
| LDAPAuthGroup | LDAPAuthGroup manages an LDAP group mapping of an OpenBao LDAP auth method at auth/<mountPath>/groups/<name>. | curated | ldapauthgroup.yaml · generated · API |
| LDAPAuthUser | LDAPAuthUser manages an LDAP user entry of an OpenBao LDAP auth method at auth/<mountPath>/users/<name>. | curated | ldapauthuser.yaml · generated · API |
| OCIAuthConfig | OCIAuthConfig manages the configuration of an OpenBao Oracle Cloud Infrastructure (OCI) auth method at auth/<mountPath>/config. | curated | ociauthconfig.yaml · generated · API |
| OCIAuthRole | OCIAuthRole manages a role of an OpenBao Oracle Cloud Infrastructure (OCI) auth method at auth/<mountPath>/role/<name>. | curated | ociauthrole.yaml · generated · API |
| OktaAuthConfig | OktaAuthConfig manages the configuration of an OpenBao Okta auth method at auth/<mountPath>/config. | curated | oktaauthconfig.yaml · generated · API |
| OktaAuthGroup | OktaAuthGroup manages the policy mapping of an Okta group in an OpenBao Okta auth method at auth/<mountPath>/groups/<name>. | curated | oktaauthgroup.yaml · generated · API |
| OktaAuthUser | OktaAuthUser manages an Okta user entry in an OpenBao Okta auth method at auth/<mountPath>/users/<name>. | curated | oktaauthuser.yaml · generated · API |
| RADIUSAuthConfig | RADIUSAuthConfig manages the configuration of an OpenBao RADIUS auth method at auth/<mountPath>/config. | curated | radiusauthconfig.yaml · generated · API |
| RADIUSAuthUser | RADIUSAuthUser manages the policies of a RADIUS user at auth/<mountPath>/users/<name>. | curated | radiusauthuser.yaml · generated · API |
| TokenRole | TokenRole manages a role of the OpenBao token store at auth/token/roles/<name>. | curated | tokenrole.yaml · generated · API |
| UserpassUser | A break-glass user whose password is read from a Secret, with short tokens bound to a CIDR, plus an auditor user. | curated | userpassuser.yaml · generated · API |
secrets.openbaoconfig.io¶
All secrets examples on one page
| Kind | Scenario | Example | Files |
|---|---|---|---|
| AWSSecretsConfig | AWSSecretsConfig sets the root credentials (<mount>/config/root) and lease settings (<mount>/config/lease) of an AWS secrets engine, an external plugin that must be registered. |
curated | awssecretsconfig.yaml · generated · API |
| AWSSecretsRole | AWSSecretsRole manages a role of an AWS secrets engine (external plugin) at <mount>/roles/<name>: the kind of AWS credential issued from <mount>/creds/<name> and the IAM policies it carries. |
curated | awssecretsrole.yaml · generated · API |
| AzureSecretsConfig | AzureSecretsConfig sets the configuration of an Azure secrets engine (external plugin) at <mount>/config: the subscription, tenant and the application credentials OpenBao uses to create service principals. |
curated | azuresecretsconfig.yaml · generated · API |
| AzureSecretsRole | AzureSecretsRole manages a role of an Azure secrets engine (external plugin) at <mount>/roles/<name>: the role assignments and groups of the service principals issued from <mount>/creds/<name>, or an existing application to add credentials to. |
curated | azuresecretsrole.yaml · generated · API |
| ConsulSecretsConfig | ConsulSecretsConfig sets the access configuration of a Consul secrets engine (external plugin) at <mount>/config/access: the Consul address and the management token OpenBao uses to create ACL tokens. |
curated | consulsecretsconfig.yaml · generated · API |
| ConsulSecretsRole | ConsulSecretsRole manages a role of a Consul secrets engine (external plugin) at <mount>/roles/<name>: the policies, roles and identities of the Consul ACL tokens issued from <mount>/creds/<name>. |
curated | consulsecretsrole.yaml · generated · API |
| DatabaseConnection | Connects the database secrets engine to PostgreSQL with root credentials and TLS material read from Secrets, and allows the roles that issue credentials from it. | curated | databaseconnection.yaml · generated · API |
| DatabaseRole | A dynamic role that creates a read-only PostgreSQL user per request, valid for an hour, and drops it when the lease ends. | curated | databaserole.yaml · generated · API |
| DatabaseStaticRole | DatabaseStaticRole manages a static role of a database secrets engine at <mount>/static-roles/<name>: OpenBao owns and rotates the password of an existing database user, served at <mount>/static-creds/<name>. |
curated | databasestaticrole.yaml · generated · API |
| GCPImpersonatedAccount | GCPImpersonatedAccount manages an impersonated account of a GCP secrets engine (external plugin) at <mount>/impersonated-account/<name>: OpenBao issues access tokens by impersonating an existing service account, without keys. |
curated | gcpimpersonatedaccount.yaml · generated · API |
| GCPRoleset | GCPRoleset manages a roleset of a GCP secrets engine (external plugin) at <mount>/roleset/<name>: OpenBao creates a service account with the given IAM bindings and issues access tokens or keys for it. |
curated | gcproleset.yaml · generated · API |
| GCPSecretsConfig | GCPSecretsConfig sets the configuration of a GCP secrets engine (external plugin) at <mount>/config: the service account credentials OpenBao uses and the lease limits. |
curated | gcpsecretsconfig.yaml · generated · API |
| GCPStaticAccount | GCPStaticAccount manages a static account of a GCP secrets engine (external plugin) at <mount>/static-account/<name>, which issues access tokens or keys for an existing service account instead of creating one. |
curated | gcpstaticaccount.yaml · generated · API |
| GitHubSecretsConfig | GitHubSecretsConfig sets the GitHub App of a GitHub secrets plugin mount (external plugin) at <mount>/config. |
curated | githubsecretsconfig.yaml · generated · API |
| GitHubSecretsRole | GitHubSecretsRole manages a permission set of a GitHub secrets plugin mount (external plugin) at <mount>/permissionset/<name>: the repositories and permissions of the installation tokens issued from <mount>/token/<name>. |
curated | githubsecretsrole.yaml · generated · API |
| KVConfig | Keeps ten versions of every secret on the secret mount and deletes versions older than 32 days. | curated | kvconfig.yaml · generated · API |
| KVSecret | Writes the KV version 2 secret secret/obco/app from two Kubernetes Secrets: every key of one, and one key of the other under a new name. | curated | kvsecret.yaml · generated · API |
| KVSecretMetadata | Per-secret KV version 2 metadata for team/app on the secret mount. | curated | kvsecretmetadata.yaml · generated · API |
| KubernetesSecretsConfig | KubernetesSecretsConfig sets the configuration of a Kubernetes secrets engine at <mount>/config: the cluster in which OpenBao creates service accounts, tokens and role bindings for KubernetesSecretsRole credentials. |
curated | kubernetessecretsconfig.yaml · generated · API |
| KubernetesSecretsRole | KubernetesSecretsRole manages a role of a Kubernetes secrets engine at <mount>/roles/<name>, from which OpenBao issues short-lived Kubernetes service account tokens (<mount>/creds/<name>). |
curated | kubernetessecretsrole.yaml · generated · API |
| LDAPSecretsConfig | LDAPSecretsConfig sets the directory connection of an LDAP secrets plugin mount (external plugin) at <mount>/config: where the directory is and the account OpenBao binds as to manage passwords. |
curated | ldapsecretsconfig.yaml · generated · API |
| LDAPSecretsDynamicRole | LDAPSecretsDynamicRole manages a dynamic role of an LDAP secrets plugin mount (external plugin) at <mount>/role/<name>: each request to <mount>/creds/<name> creates a short-lived directory account from LDIF templates. |
curated | ldapsecretsdynamicrole.yaml · generated · API |
| LDAPSecretsStaticRole | LDAPSecretsStaticRole manages a static role of an LDAP secrets plugin mount (external plugin) at <mount>/static-role/<name>: OpenBao owns and rotates the password of an existing directory account, served at <mount>/static-cred/<name>. |
curated | ldapsecretsstaticrole.yaml · generated · API |
| MongoDBAtlasSecretsConfig | MongoDBAtlasSecretsConfig sets the programmatic API key of a MongoDB Atlas secrets plugin mount (external plugin) at <mount>/config, which OpenBao uses to create short-lived Atlas API keys. |
curated | mongodbatlassecretsconfig.yaml · generated · API |
| MongoDBAtlasSecretsRole | MongoDBAtlasSecretsRole manages a role of a MongoDB Atlas secrets plugin mount (external plugin) at <mount>/roles/<name>: the Atlas roles and access list of the programmatic API keys issued from <mount>/creds/<name>. |
curated | mongodbatlassecretsrole.yaml · generated · API |
| NomadSecretsConfig | NomadSecretsConfig sets the cluster connection (<mount>/config/access) and lease limits (<mount>/config/lease) of a Nomad secrets plugin mount (external plugin), which issues Nomad ACL tokens. |
curated | nomadsecretsconfig.yaml · generated · API |
| NomadSecretsRole | NomadSecretsRole manages a role of a Nomad secrets plugin mount (external plugin) at <mount>/role/<name>: the type and policies of the Nomad ACL tokens issued from <mount>/creds/<name>. |
curated | nomadsecretsrole.yaml · generated · API |
| PKIACMEConfig | PKIACMEConfig sets the ACME server configuration of a PKI secrets engine at <mount>/config/acme, so ACME clients such as cert-manager or certbot can request certificates. |
curated | pkiacmeconfig.yaml · generated · API |
| PKIAutoTidy | PKIAutoTidy sets the periodic tidy configuration of a PKI secrets engine at <mount>/config/auto-tidy, which removes expired certificates, issuers and ACME data on a schedule. |
curated | pkiautotidy.yaml · generated · API |
| PKICELRole | CEL policy for certificate issuance on the default pki mount. | curated | pkicelrole.yaml · generated · API |
| PKIConfig | PKIConfig sets the mount-wide configuration of a PKI secrets engine: AIA URLs (config/urls), CRL (config/crl), cluster address (config/cluster) and default issuer (config/issuers). |
curated | pkiconfig.yaml · generated · API |
| PKIIssuer | Generates an EC P-384 root CA issuer inside OpenBao on the obco-pki-root mount. | curated | pkiissuer.yaml · generated · API |
| PKIKey | PKIKey manages a private key of a PKI secrets engine at <mount>/key/<name>, generated in OpenBao, backed by an external key, or imported from a Secret. |
curated | pkikey.yaml · generated · API |
| PKIKeyConfig | Default signing key for the pki mount; the config path cannot be deleted. | curated | pkikeyconfig.yaml · generated · API |
| PKIRole | A certificate role on the intermediate CA mount that issues 24-hour certificates for subdomains of openbao-config.example.com, including a domain templated from the requester's entity metadata. | curated | pkirole.yaml · generated · API |
| QuaySecretsConfig | QuaySecretsConfig sets the Quay instance of a Quay secrets plugin mount (external plugin) at <mount>/config, in which OpenBao creates robot accounts. |
curated | quaysecretsconfig.yaml · generated · API |
| QuaySecretsRole | QuaySecretsRole manages a role of a Quay secrets plugin mount (external plugin) at <mount>/roles/<name>: each request to <mount>/creds/<name> creates a short-lived robot account with the listed permissions. |
curated | quaysecretsrole.yaml · generated · API |
| QuaySecretsStaticRole | QuaySecretsStaticRole manages a static role of a Quay secrets plugin mount (external plugin) at <mount>/static-roles/<name>: one long-lived robot account whose token is served at <mount>/static-creds/<name>. |
curated | quaysecretsstaticrole.yaml · generated · API |
| RabbitMQConfig | RabbitMQConfig sets the connection (<mount>/config/connection) and lease settings (<mount>/config/lease) of a RabbitMQ secrets engine, which issues dynamic RabbitMQ users. |
curated | rabbitmqconfig.yaml · generated · API |
| RabbitMQRole | RabbitMQRole manages a role of a RabbitMQ secrets engine at <mount>/roles/<name>: the tags and virtual host permissions of the dynamic users issued from <mount>/creds/<name>. |
curated | rabbitmqrole.yaml · generated · API |
| RandomSecret | Generates a session key once, stores it in KV and copies it to a Kubernetes Secret; changing refreshNonce regenerates it. | curated | randomsecret.yaml · generated · API |
| SSHCA | SSHCA configures the default signing CA of an SSH secrets engine at <mount>/config/ca, generated by OpenBao or imported from a Secret. |
curated | sshca.yaml · generated · API |
| SSHRole | SSHRole manages a role of an SSH secrets engine at <mount>/roles/<name>: a ca role signs SSH user or host certificates with the SSHCA, an otp role issues one-time SSH passwords. |
curated | sshrole.yaml · generated · API |
| TOTPKey | TOTPKey manages a key of a TOTP secrets engine at <mount>/keys/<name>, either generated by OpenBao or imported from a Secret. |
curated | totpkey.yaml · generated · API |
| TerraformCloudSecretsConfig | TerraformCloudSecretsConfig sets the instance and API token of a Terraform Cloud secrets plugin mount (external plugin) at <mount>/config, which issues HCP Terraform or Terraform Enterprise API tokens. |
curated | terraformcloudsecretsconfig.yaml · generated · API |
| TerraformCloudSecretsRole | TerraformCloudSecretsRole manages a role of a Terraform Cloud secrets plugin mount (external plugin) at <mount>/role/<name>: which organization, team or user API tokens are issued from <mount>/creds/<name>. |
curated | terraformcloudsecretsrole.yaml · generated · API |
| TransitCacheConfig | Bound the Transit cache to 100 entries; use size 0 for an unlimited cache. | curated | transitcacheconfig.yaml · generated · API |
| TransitKey | An AES-256-GCM transit key for application encryption that rotates every 30 days, plus an HMAC key. | curated | transitkey.yaml · generated · API |
| TransitKeyConfig | Mount-wide transit key defaults on the transit mount. | curated | transitkeyconfig.yaml · generated · API |
identity.openbaoconfig.io¶
All identity examples on one page
| Kind | Scenario | Example | Files |
|---|---|---|---|
| Entity | Identity entities for two people, with policies and metadata; logins are linked to them by EntityAlias resources. | curated | entity.yaml · generated · API |
| EntityAlias | EntityAlias links a login on an auth mount to an OpenBao identity entity (identity/entity-alias). |
curated | entityalias.yaml · generated · API |
| Group | Internal identity groups that grant policies to their members (added with GroupMembership), plus an external group for an identity provider group. | curated | group.yaml · generated · API |
| GroupAlias | GroupAlias links a group of an identity provider to an external OpenBao group (identity/group-alias). |
curated | groupalias.yaml · generated · API |
| GroupMembership | GroupMembership adds entities or subgroups to an internal OpenBao group (member_entity_ids, member_group_ids of identity/group/id/<id>). |
curated | groupmembership.yaml · generated · API |
| MFALoginEnforcement | MFALoginEnforcement requires login MFA at identity/mfa/login-enforcement/<name> for the selected auth mounts, auth method types, entities or groups. |
curated | mfaloginenforcement.yaml · generated · API |
| MFAMethod | MFAMethod manages a login MFA method (TOTP, Duo, Okta or PingID) at identity/mfa/method/<type>/<id>. |
curated | mfamethod.yaml · generated · API |
| 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. |
curated | oidcassignment.yaml · generated · API |
| OIDCClient | OIDCClient manages an application that logs users in through the OpenBao OIDC provider, at identity/oidc/client/<name>. |
curated | oidcclient.yaml · generated · API |
| OIDCConfig | OIDCConfig sets the identity token (OIDC) configuration of an OpenBao namespace at identity/oidc/config, a singleton. |
curated | oidcconfig.yaml · generated · API |
| OIDCKey | OIDCKey manages a named key at identity/oidc/key/<name> that signs OpenBao identity tokens and OIDC provider tokens. |
curated | oidckey.yaml · generated · API |
| OIDCProvider | OIDCProvider manages an OpenID Connect provider served by OpenBao at identity/oidc/provider/<name>. |
curated | oidcprovider.yaml · generated · API |
| OIDCRole | OIDCRole manages a role at identity/oidc/role/<name> that OpenBao identity tokens are issued against (identity/oidc/token/<name>). |
curated | oidcrole.yaml · generated · API |
| 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. |
curated | oidcscope.yaml · generated · API |
access.openbaoconfig.io¶
All access examples on one page
| Kind | Scenario | Example | Files |
|---|---|---|---|
| AccessGrant | Gives the payments ServiceAccounts write access to their own KV paths and read access to shared paths per organization, through one generated ACL policy and one Kubernetes auth role per subject. | curated | accessgrant.yaml · generated · API |
| AccessLayout | Gives people access by identity provider group: per organization, developers can write and leads own the org paths, while in the prod namespace developers only read and leads write. | curated | accesslayout.yaml · generated · API |
| AccessLevel | Reusable capability sets on KV data and metadata (read, write, owner) that AccessGrant and AccessLayout rules name. | curated | accesslevel.yaml · generated · API |
Other example sets¶
examples/quickstart/: the manifests of the quickstart tutorial.examples/tutorials/: the manifests of the role-based tutorials, in the order they build on each other.examples/policies/templated/: templated ACL policies, in the order they build on each other.examples/live/: the live kit: kustomize overlays that apply every kind to a real OpenBao, by login mode.examples/self-init/: an OpenBao self-init configuration and its verification script.