Skip to content

sys.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.

Audit

Audit enables an OpenBao audit device at sys/audit/<path>, in the root namespace only; every field is immutable.

API reference

examples/sys/audit.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Audit
metadata:
  name: obco-stdout
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Adopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 15m
  path: stdout
  type: file
  description: audit log to standard output, declared in the server configuration
  local: false
  options:
    file_path: stdout
---
apiVersion: v1
kind: Secret
metadata:
  name: obco-siem-audit
  namespace: openbao-config
type: Opaque
stringData:
  headers: '{"Authorization":["Bearer fake-siem-token"]}'
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Audit
metadata:
  name: obco-siem
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  managementPolicy: Manage
  path: siem
  type: http
  description: audit events forwarded to the SIEM collector
  local: true
  options:
    uri: https://siem-collector.example.com/openbao
    format: json
    hmac_accessor: "true"
  optionsSecretRefs:
    headers:
      name: obco-siem-audit
      key: headers
examples-generated/sys/audit.yaml
# Audit (sys.openbaoconfig.io/v1alpha1)
# Audit enables an OpenBao audit device at sys/audit/<path>, in the root namespace only; every field is immutable.
#
# 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, type.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#audit
# Curated example: examples/sys/audit.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Audit
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  description: example
  driftDetection: Enabled
  driftInterval: 1h
  local: true
  managementPolicy: Manage
  options:
    example: example
  path: example
  type: file

AuditRequestHeader

AuditRequestHeader makes the OpenBao audit devices record an HTTP request header, at sys/config/auditing/request-headers/<name>, in the root namespace only.

API reference

examples/sys/auditrequestheader.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuditRequestHeader
metadata:
  name: obco-forwarded-for
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: X-Forwarded-For
  hmac: false
examples/sys/auditrequestheader-attribution.yaml
# Makes OpenBao record the X-Openbao-Config-Resource header that the operator sends with every request
# (<group>/<kind>/<k8s-namespace>/<name>), in clear text, so each audit entry traces to its custom resource.
# Request headers are configured in the root namespace, so use a connection whose OpenBao namespace is root.
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuditRequestHeader
metadata:
  name: obco-resource-attribution
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  name: X-Openbao-Config-Resource
  hmac: false
examples-generated/sys/auditrequestheader.yaml
# AuditRequestHeader (sys.openbaoconfig.io/v1alpha1)
# AuditRequestHeader makes the OpenBao audit devices record an HTTP request header, at
# sys/config/auditing/request-headers/<name>, in the root namespace only.
#
# 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/sys/#auditrequestheader
# Curated example: examples/sys/auditrequestheader.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuditRequestHeader
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  hmac: true
  managementPolicy: Manage
  name: example

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.

API reference

examples/sys/authmount.yaml
# 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.
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuthMount
metadata:
  name: obco-approle
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 15m
  managementPolicy: Manage
  path: approle-ci
  type: approle
  description: AppRole logins for CI pipelines
  local: false
  sealWrap: false
  externalEntropyAccess: false
  forceNoCache: false
  pluginVersion: ""
  options: {}
  defaultLeaseTTL: 1h
  maxLeaseTTL: 24h
  listingVisibility: hidden
  auditNonHMACRequestKeys:
    - role_id
  auditNonHMACResponseKeys:
    - role_id
  passthroughRequestHeaders:
    - X-Request-Id
  allowedResponseHeaders:
    - X-Request-Id
  tokenType: default-service
  userLockout:
    threshold: 5
    duration: 15m
    counterResetDuration: 10m
    disable: false
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuthMount
metadata:
  name: obco-ldap
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 15m
  managementPolicy: Manage
  path: ldap
  type: ldap
  pluginRef:
    name: obco-ldap-auth-plugin
  description: LDAP logins through the external plugin registered by the Plugin obco-ldap-auth-plugin
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuthMount
metadata:
  name: obco-kubernetes
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 15m
  managementPolicy: Manage
  path: kubernetes
  type: kubernetes
  description: Kubernetes ServiceAccount logins from the workload cluster
examples-generated/sys/authmount.yaml
# AuthMount (sys.openbaoconfig.io/v1alpha1)
# AuthMount enables and tunes an OpenBao auth method at sys/auth/<path> (logins then go to auth/<path>/login).
#
# 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, type.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#authmount
# Curated example: examples/sys/authmount.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: AuthMount
metadata:
  name: example
  namespace: openbao-config
spec:
  allowedResponseHeaders:
  - example
  auditNonHMACRequestKeys:
  - example
  auditNonHMACResponseKeys:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  defaultLeaseTTL: 1h
  deletionPolicy: Orphan
  description: example
  driftDetection: Enabled
  driftInterval: 1h
  externalEntropyAccess: true
  forceNoCache: true
  listingVisibility: unauth
  local: true
  managementPolicy: Manage
  maxLeaseTTL: 1h
  namespace: example
  options:
    example: example
  passthroughRequestHeaders:
  - example
  path: example
  pluginRef:
    name: example
  pluginVersion: example
  sealWrap: true
  tokenType: default-service
  type: approle
  userLockout:
    counterResetDuration: 1h
    disable: true
    duration: 1h
    threshold: 1

CORSConfig

CORSConfig enables cross-origin (CORS) requests to OpenBao at sys/config/cors, a server-wide singleton in the root namespace.

API reference

examples/sys/corsconfig.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: CORSConfig
metadata:
  name: obco-cors
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  allowedOrigins:
    - https://openbao.example.com
    - https://backstage.example.com
  allowedHeaders:
    - X-Request-Id
    - X-Correlation-Id
  allowCredentials: true
examples-generated/sys/corsconfig.yaml
# CORSConfig (sys.openbaoconfig.io/v1alpha1)
# CORSConfig enables cross-origin (CORS) requests to OpenBao at sys/config/cors, a server-wide singleton in the root
# namespace.
#
# 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: allowedOrigins, connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#corsconfig
# Curated example: examples/sys/corsconfig.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: CORSConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  allowCredentials: true
  allowedHeaders:
  - example
  allowedOrigins:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage

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.

API reference

examples/sys/keyrotationconfig.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: KeyRotationConfig
metadata:
  name: obco-key-rotation
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  enabled: true
  maxOperations: 1000000000
  interval: 720h
examples-generated/sys/keyrotationconfig.yaml
# KeyRotationConfig (sys.openbaoconfig.io/v1alpha1)
# 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.
#
# 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/sys/#keyrotationconfig
# Curated example: examples/sys/keyrotationconfig.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: KeyRotationConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  enabled: true
  interval: "0"
  managementPolicy: Manage
  maxOperations: 1000000
  namespace: example

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.

API reference

examples/sys/logger.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Logger
metadata:
  name: obco-core-debug
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: core
  level: debug
examples-generated/sys/logger.yaml
# Logger (sys.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, level.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#logger
# Curated example: examples/sys/logger.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Logger
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  level: trace
  managementPolicy: Manage
  name: example

OpenBaoNamespace

Creates the OpenBao namespace team-a with custom metadata; with deletionPolicy Orphan the namespace and its contents stay when the resource is deleted.

API reference

examples/sys/openbaonamespace.yaml
# Creates the OpenBao namespace team-a with custom metadata; with deletionPolicy Orphan the namespace and its
# contents stay when the resource is deleted.
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: OpenBaoNamespace
metadata:
  name: obco-team-a
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: team-a
  customMetadata:
    owner: team-a
    cost-center: "4711"
examples-generated/sys/openbaonamespace.yaml
# OpenBaoNamespace (sys.openbaoconfig.io/v1alpha1)
# OpenBaoNamespace creates an OpenBao namespace at sys/namespaces/<name> inside the parent namespace selected by
# namespace (the connection namespace when unset).
#
# 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/sys/#openbaonamespace
# Curated example: examples/sys/openbaonamespace.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: OpenBaoNamespace
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  customMetadata:
    example: example
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: example
  namespace: example

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.

API reference

examples/sys/passwordpolicy.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: PasswordPolicy
metadata:
  name: obco-db-passwords
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: db-passwords
  policy: |
    length = 24
    rule "charset" {
      charset = "abcdefghijklmnopqrstuvwxyz"
      min-chars = 1
    }
    rule "charset" {
      charset = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
      min-chars = 1
    }
    rule "charset" {
      charset = "0123456789"
      min-chars = 1
    }
examples-generated/sys/passwordpolicy.yaml
# PasswordPolicy (sys.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, policy.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#passwordpolicy
# Curated example: examples/sys/passwordpolicy.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: PasswordPolicy
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
  policy: |
    path "secret/data/example/*" {
      capabilities = ["read"]
    }

Plugin

Plugin registers an external plugin in the OpenBao plugin catalog at sys/plugins/catalog/<type>/<name>, so mounts can use it.

API reference

examples/sys/plugin.yaml
apiVersion: v1
kind: Secret
metadata:
  name: obco-ldap-plugin-env
  namespace: openbao-config
type: Opaque
stringData:
  https-proxy: http://obco-plugin:fake-proxy-password@proxy.example.com:3128
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Plugin
metadata:
  name: obco-ldap-auth-plugin
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  type: auth
  name: ldap
  command: openbao-plugin-auth-ldap
  sha256: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
  args:
    - -tls-skip-verify=false
  env:
    - name: HTTPS_PROXY
      secretKeyRef:
        name: obco-ldap-plugin-env
        key: https-proxy
  version: v0.1.0
  oci: false
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Plugin
metadata:
  name: obco-nomad-secrets-plugin
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  type: secret
  name: nomad
  command: openbao-plugin-secrets-nomad
  sha256: 89abcdef0123456789abcdef0123456789abcdef0123456789abcdef01234567
  oci: true
examples-generated/sys/plugin.yaml
# Plugin (sys.openbaoconfig.io/v1alpha1)
# Plugin registers an external plugin in the OpenBao plugin catalog at sys/plugins/catalog/<type>/<name>, so mounts
# can use it.
#
# 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: command, connectionRef, sha256, type.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#plugin
# Curated example: examples/sys/plugin.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Plugin
metadata:
  name: example
  namespace: openbao-config
spec:
  args:
  - example
  command: example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  env:
  - name: example
    secretKeyRef:
      key: value
      name: example
  managementPolicy: Manage
  name: example
  oci: true
  sha256: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  type: auth
  version: 0.0.0

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.

API reference

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
examples-generated/sys/policy.yaml
# Policy (sys.openbaoconfig.io/v1alpha1)
# Policy manages an OpenBao ACL policy at sys/policies/acl/<name>, which grants capabilities on paths to the tokens it
# is attached to.
#
# 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, policy.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#policy
# Curated example: examples/sys/policy.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Policy
metadata:
  name: example
  namespace: openbao-config
spec:
  accessorRefs:
    example:
      authMountRef:
        name: example
  allowSlashesInIdentityTemplates: true
  allowWildcardsInIdentityTemplates: true
  casRequired: true
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: example
  namespace: example
  policy: |
    path "secret/data/example/*" {
      capabilities = ["read"]
    }

QuotaConfig

QuotaConfig manages the server-wide rate-limit quota settings at sys/quotas/config: exempt paths, audit logging of rejections and response headers.

API reference

examples/sys/quotaconfig.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: QuotaConfig
metadata:
  name: obco-quota-config
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  rateLimitExemptPaths:
    - sys/generate-recovery-token/attempt
    - sys/generate-recovery-token/update
    - sys/generate-root/attempt
    - sys/generate-root/update
    - sys/health
    - sys/seal-status
    - sys/unseal
    - sys/metrics
  enableRateLimitAuditLogging: true
  enableRateLimitResponseHeaders: true
examples-generated/sys/quotaconfig.yaml
# QuotaConfig (sys.openbaoconfig.io/v1alpha1)
# QuotaConfig manages the server-wide rate-limit quota settings at sys/quotas/config: exempt paths, audit logging of
# rejections and response headers.
#
# 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/sys/#quotaconfig
# Curated example: examples/sys/quotaconfig.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: QuotaConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  enableRateLimitAuditLogging: true
  enableRateLimitResponseHeaders: true
  managementPolicy: Manage
  rateLimitExemptPaths:
  - example

RaftAutopilot

RaftAutopilot manages the raft autopilot settings at sys/storage/raft/autopilot/configuration: dead server cleanup, health thresholds and voter promotion.

API reference

examples/sys/raftautopilot.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: RaftAutopilot
metadata:
  name: obco-autopilot
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  cleanupDeadServers: true
  lastContactThreshold: 10s
  deadServerLastContactThreshold: 24h
  maxTrailingLogs: 1000
  minQuorum: 3
  serverStabilizationTime: 10s
examples-generated/sys/raftautopilot.yaml
# RaftAutopilot (sys.openbaoconfig.io/v1alpha1)
# RaftAutopilot manages the raft autopilot settings at sys/storage/raft/autopilot/configuration: dead server cleanup,
# health thresholds and voter promotion.
#
# 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/sys/#raftautopilot
# Curated example: examples/sys/raftautopilot.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: RaftAutopilot
metadata:
  name: example
  namespace: openbao-config
spec:
  cleanupDeadServers: true
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deadServerLastContactThreshold: 1h
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  lastContactThreshold: 1h
  managementPolicy: Manage
  maxTrailingLogs: 1
  minQuorum: 3
  serverStabilizationTime: 1h

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.

API reference

examples/sys/ratelimitquota.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: RateLimitQuota
metadata:
  name: obco-kv-limit
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: openbao-config-approle-ci
  path: openbao-config/auth/approle-ci
  role: ci
  rate: "50"
  interval: 1s
  blockInterval: 30s
  inheritable: false
examples-generated/sys/ratelimitquota.yaml
# RateLimitQuota (sys.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, rate.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#ratelimitquota
# Curated example: examples/sys/ratelimitquota.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: RateLimitQuota
metadata:
  name: example
  namespace: openbao-config
spec:
  blockInterval: 1h
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  inheritable: true
  interval: 1h
  managementPolicy: Manage
  name: example
  path: example
  rate: "1"
  role: example

SecretsMount

Enables a KV version 2 secrets engine at team-a/kv, plus a Nomad engine (external plugin) at nomad.

API reference

examples/sys/secretsmount.yaml
# Enables a KV version 2 secrets engine at team-a/kv, plus a Nomad engine (external plugin) at nomad. With
# deletionPolicy Orphan the mount and its data stay in OpenBao when the resource is deleted.
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: SecretsMount
metadata:
  name: obco-kv
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  path: team-a/kv
  type: kv
  description: Key-value secrets of team a
  local: false
  sealWrap: false
  externalEntropyAccess: false
  forceNoCache: false
  pluginVersion: ""
  options:
    version: "2"
  defaultLeaseTTL: 768h
  maxLeaseTTL: 768h
  listingVisibility: hidden
  auditNonHMACRequestKeys:
    - path
  auditNonHMACResponseKeys:
    - version
  passthroughRequestHeaders:
    - X-Request-Id
  allowedResponseHeaders:
    - X-Request-Id
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: SecretsMount
metadata:
  name: obco-nomad
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  path: nomad
  type: nomad
  pluginRef:
    name: obco-nomad-secrets-plugin
  description: Nomad tokens through the external plugin registered by the Plugin obco-nomad-secrets-plugin
examples-generated/sys/secretsmount.yaml
# SecretsMount (sys.openbaoconfig.io/v1alpha1)
# SecretsMount enables and tunes an OpenBao secrets engine at sys/mounts/<path>, such as a KV, PKI, transit or
# database engine.
#
# 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, type.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#secretsmount
# Curated example: examples/sys/secretsmount.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: SecretsMount
metadata:
  name: example
  namespace: openbao-config
spec:
  allowedResponseHeaders:
  - example
  auditNonHMACRequestKeys:
  - example
  auditNonHMACResponseKeys:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  defaultLeaseTTL: 1h
  deletionPolicy: Orphan
  description: example
  driftDetection: Enabled
  driftInterval: 1h
  externalEntropyAccess: true
  forceNoCache: true
  listingVisibility: unauth
  local: true
  managementPolicy: Manage
  maxLeaseTTL: 1h
  namespace: example
  options:
    example: example
  passthroughRequestHeaders:
  - example
  path: example
  pluginRef:
    name: example
  pluginVersion: example
  sealWrap: true
  type: example

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.

API reference

examples/sys/uiheader.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: UIHeader
metadata:
  name: obco-permissions-policy
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: Permissions-Policy
  values:
    - camera=()
    - microphone=()
examples-generated/sys/uiheader.yaml
# UIHeader (sys.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, values.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#uiheader
# Curated example: examples/sys/uiheader.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: UIHeader
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: example
  values:
  - example

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>.

API reference

examples/sys/workflow.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Workflow
metadata:
  name: obco-generate-password
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  path: obco/generate-password
  description: Generates a password with a password policy and stores it in a KV v2 mount.
  casRequired: true
  allowUnauthenticated: false
  workflow: |
    input {
      field "policy" {
        type     = "string"
        required = true
      }
      field "mount" {
        type     = "string"
        required = true
      }
      field "secret" {
        type     = "string"
        required = true
      }
    }

    flow "generate-password" {
      request "generate" {
        operation = "read"
        path = {
          eval_source = "template"
          eval_type   = "string"
          template    = "sys/policies/password/{{ .input.policy }}/generate"
        }
      }

      request "store" {
        operation = "update"
        path = {
          eval_source = "template"
          eval_type   = "string"
          template    = "{{ .input.mount }}/data/{{ .input.secret }}"
        }
        data = {
          data = {
            "password" = {
              eval_source    = "response"
              eval_type      = "string"
              flow_name      = "generate-password"
              response_name  = "generate"
              field_selector = ["data", "password"]
            }
          }
        }
      }
    }

    output {
      data = {
        stored = {
          eval_source = "template"
          eval_type   = "string"
          template    = "{{ .input.mount }}/data/{{ .input.secret }}"
        }
      }
    }
examples-generated/sys/workflow.yaml
# Workflow (sys.openbaoconfig.io/v1alpha1)
# 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>.
#
# 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, workflow.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/sys/#workflow
# Curated example: examples/sys/workflow.yaml
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Workflow
metadata:
  name: example
  namespace: openbao-config
spec:
  allowUnauthenticated: true
  casRequired: true
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  description: example
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  namespace: example
  path: example
  workflow: example