secrets.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.
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.
apiVersion: v1
kind: Secret
metadata:
name: obco-aws-root
namespace: openbao-config
type: Opaque
stringData:
access-key-id: AKIAFAKEEXAMPLE00001
secret-access-key: fake-aws-secret-access-key-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AWSSecretsConfig
metadata:
name: obco-aws
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: aws
accessKeySecretRef:
name: obco-aws-root
key: access-key-id
secretKeySecretRef:
name: obco-aws-root
key: secret-access-key
region: eu-central-1
iamEndpoint: https://iam.amazonaws.com
stsEndpoint: https://sts.eu-central-1.amazonaws.com
maxRetries: 3
usernameTemplate: '{{ printf "obco-%s-%s" (unix_time) (random 20) | truncate 64 }}'
lease: 30m
leaseMax: 12h
# AWSSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#awssecretsconfig
# Curated example: examples/secrets/awssecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AWSSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
accessKeySecretRef:
key: value
name: awssecretsconfig-access-key-secret-ref
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
iamEndpoint: https://openbao.example.com:8200
lease: 1h
leaseMax: 1h
managementPolicy: Manage
maxRetries: 1
mountPath: aws
namespace: example
region: example
secretKeySecretRef:
key: value
name: awssecretsconfig-secret-key-secret-ref
stsEndpoint: https://openbao.example.com:8200
usernameTemplate: example
---
apiVersion: v1
kind: Secret
metadata:
name: awssecretsconfig-access-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
name: awssecretsconfig-secret-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AWSSecretsRole
metadata:
name: obco-aws-deploy
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: aws
name: deploy
credentialType: assumed_role
roleARNs:
- arn:aws:iam::123456789012:role/obco-deploy
policyARNs:
- arn:aws:iam::aws:policy/ReadOnlyAccess
policyDocument: |
{
"Version": "2012-10-17",
"Statement": [
{"Effect": "Allow", "Action": ["s3:ListBucket", "s3:GetObject"], "Resource": "arn:aws:s3:::obco-artifacts/*"}
]
}
iamGroups:
- obco-readers
sessionTags:
team: platform
env: sandbox
externalID: openbao-config-external-id
defaultSTSTTL: 15m
maxSTSTTL: 1h
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AWSSecretsRole
metadata:
name: obco-aws-ci-user
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: aws
name: ci-user
credentialType: iam_user
policyARNs:
- arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
iamTags:
team: platform
managed-by: openbao
userPath: /obco/
permissionsBoundaryARN: arn:aws:iam::123456789012:policy/obco-boundary
mfaSerialNumber: arn:aws:iam::123456789012:mfa/obco-ci
# AWSSecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, credentialType.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#awssecretsrole
# Curated example: examples/secrets/awssecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AWSSecretsRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
credentialType: iam_user
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
externalID: example
iamGroups:
- example
iamTags:
example: example
managementPolicy: Manage
mfaSerialNumber: example
mountPath: aws
name: example
namespace: example
permissionsBoundaryARN: arn:aws:iam::123456789012:policy/example
policyARNs:
- default
policyDocument: default
sessionTags:
example: example
userPath: /
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.
apiVersion: v1
kind: Secret
metadata:
name: obco-azure-sp
namespace: openbao-config
type: Opaque
stringData:
client-id: 11111111-1111-1111-1111-111111111111
client-secret: fake-azure-client-secret-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AzureSecretsConfig
metadata:
name: obco-azure
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: azure
subscriptionID: 00000000-0000-0000-0000-000000000001
tenantID: 00000000-0000-0000-0000-000000000002
clientIDSecretRef:
name: obco-azure-sp
key: client-id
clientSecretSecretRef:
name: obco-azure-sp
key: client-secret
environment: AzurePublicCloud
passwordPolicy: obco-azure-sp
rootPasswordTTL: 4380h
# AzureSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef,
# subscriptionID, tenantID.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#azuresecretsconfig
# Curated example: examples/secrets/azuresecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AzureSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
clientIDSecretRef:
key: value
name: azuresecretsconfig-client-id-secret-ref
clientSecretSecretRef:
key: value
name: azuresecretsconfig-client-secret-secret-ref
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
environment: AzurePublicCloud
managementPolicy: Manage
mountPath: azure
namespace: example
passwordPolicy: default
rootPasswordTTL: 1h
subscriptionID: example
tenantID: example
---
apiVersion: v1
kind: Secret
metadata:
name: azuresecretsconfig-client-id-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
name: azuresecretsconfig-client-secret-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AzureSecretsRole
metadata:
name: obco-azure-reader
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: azure
name: reader
azureRoles:
- roleName: Reader
scope: /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/openbao-config
- roleID: /subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7
scope: /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/obco-shared
azureGroups:
- groupName: obco-readers
- groupName: obco-auditors
objectID: 22222222-2222-2222-2222-222222222222
persistApp: false
ttl: 1h
maxTTL: 24h
explicitMaxTTL: 720h
permanentlyDelete: true
signInAudience: AzureADMyOrg
tags:
- team:platform
- env:sandbox
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AzureSecretsRole
metadata:
name: obco-azure-existing-app
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: azure
name: existing-app
applicationObjectID: 33333333-3333-3333-3333-333333333333
ttl: 1h
maxTTL: 8h
# AzureSecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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/secrets/#azuresecretsrole
# Curated example: examples/secrets/azuresecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AzureSecretsRole
metadata:
name: example
namespace: openbao-config
spec:
applicationObjectID: example
azureGroups:
- groupName: example
objectID: example
azureRoles:
- roleID: example
roleName: example
scope: example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
explicitMaxTTL: 1h
managementPolicy: Manage
maxTTL: 1h
mountPath: azure
name: example
namespace: example
permanentlyDelete: true
persistApp: true
signInAudience: AzureADMyOrg
tags:
- example
ttl: 1h
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.
apiVersion: v1
kind: Secret
metadata:
name: obco-consul
namespace: openbao-config
type: Opaque
stringData:
token: 00000000-fake-consul-token-not-real
tls.key: fake-consul-client-key-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: ConsulSecretsConfig
metadata:
name: obco-consul
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: consul
address: consul.openbao-config.svc:8501
scheme: https
tokenSecretRef:
name: obco-consul
key: token
caCert: |
-----BEGIN CERTIFICATE-----
RkFLRS1DQS1DRVJUSUZJQ0FURS1OT1QtUkVBTA==
-----END CERTIFICATE-----
clientCert: |
-----BEGIN CERTIFICATE-----
RkFLRS1DTElFTlQtQ0VSVElGSUNBVEUtTk9ULVJFQUw=
-----END CERTIFICATE-----
clientKeySecretRef:
name: obco-consul
key: tls.key
# ConsulSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: address, connectionRef,
# tokenSecretRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#consulsecretsconfig
# Curated example: examples/secrets/consulsecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: ConsulSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
address: https://openbao.example.com:8200
caCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
clientCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
clientKeySecretRef:
key: value
name: consulsecretsconfig-client-key-secret-ref
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: consul
namespace: example
scheme: http
tokenSecretRef:
key: value
name: consulsecretsconfig-token-secret-ref
---
apiVersion: v1
kind: Secret
metadata:
name: consulsecretsconfig-client-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
name: consulsecretsconfig-token-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: ConsulSecretsRole
metadata:
name: obco-consul-app
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: consul
name: app
consulPolicies:
- obco-read-kv
consulRoles:
- obco-ops
serviceIdentities:
- obco-web:dc1,dc2
nodeIdentities:
- obco-node-1:dc1
consulNamespace: obco
partition: default
local: true
ttl: 1h
maxTTL: 24h
# ConsulSecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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/secrets/#consulsecretsrole
# Curated example: examples/secrets/consulsecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: ConsulSecretsRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
consulNamespace: example
consulPolicies:
- default
consulRoles:
- example
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
local: true
managementPolicy: Manage
maxTTL: 1h
mountPath: consul
name: example
namespace: example
nodeIdentities:
- example
partition: example
serviceIdentities:
- example
ttl: 1h
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.
# 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.
apiVersion: v1
kind: Secret
metadata:
name: obco-db-root
namespace: openbao-config
type: Opaque
stringData:
password: fake-root-password-not-real
private-key: fake-private-key-not-real
---
apiVersion: v1
kind: Secret
metadata:
name: obco-db-tls
namespace: openbao-config
type: Opaque
stringData:
client.pem: fake-client-certificate-and-key-not-real
bundle.pem: fake-pem-bundle-not-real
issue.json: '{"certificate":"fake-not-real","private_key":"fake-not-real","issuing_ca":"fake-not-real"}'
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseConnection
metadata:
name: obco-postgres
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: database
name: postgres
pluginName: postgresql-database-plugin
verifyConnection: true
allowedRoles:
- obco-app-ro
- obco-app-cert
- obco-app-static
rootRotationStatements:
- ALTER USER "{{name}}" WITH PASSWORD '{{password}}';
passwordPolicy: obco-db
passwordSecretRef:
name: obco-db-root
key: password
rotateRootOnCreate: true
postgresql:
connectionURL: postgresql://{{username}}:{{password}}@postgres.openbao-config.svc:5432/app?sslmode=require
username: openbao-root
maxOpenConnections: 8
maxIdleConnections: 4
maxConnectionLifetime: 5m
usernameTemplate: '{{ printf "v-%s-%s" (.RoleName | truncate 16) (random 8) }}'
disableEscaping: false
passwordAuthentication: scram-sha-256
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseConnection
metadata:
name: obco-mysql
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: database
pluginName: mysql-database-plugin
verifyConnection: false
allowedRoles:
- '*'
passwordSecretRef:
name: obco-db-root
key: password
mysql:
connectionURL: '{{username}}:{{password}}@tcp(mysql.openbao-config.svc:3306)/'
username: openbao-root
maxOpenConnections: 4
maxIdleConnections: 2
maxConnectionLifetime: 1m
usernameTemplate: '{{ .RoleName | truncate 10 }}-{{ random 6 }}'
tlsCA: |
-----BEGIN CERTIFICATE-----
ZmFrZS1jYS1ub3QtcmVhbA==
-----END CERTIFICATE-----
tlsCertificateKeySecretRef:
name: obco-db-tls
key: client.pem
tlsServerName: mysql.openbao-config.svc
tlsSkipVerify: false
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseConnection
metadata:
name: obco-cassandra
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: database
pluginName: cassandra-database-plugin
verifyConnection: false
allowedRoles:
- obco-cassandra
passwordSecretRef:
name: obco-db-root
key: password
cassandra:
hosts:
- cassandra-0.cassandra.openbao-config.svc
- cassandra-1.cassandra.openbao-config.svc
port: 9042
protocolVersion: 4
username: cassandra
tls: true
insecureTLS: false
tlsServerName: cassandra.openbao-config.svc
tlsMinVersion: tls12
pemBundleSecretRef:
name: obco-db-tls
key: bundle.pem
skipVerification: false
connectTimeout: 5s
socketKeepAlive: 30s
consistency: LOCAL_QUORUM
localDatacenter: dc1
usernameTemplate: '{{ .RoleName }}_{{ random 8 }}'
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseConnection
metadata:
name: obco-influxdb
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: database
pluginName: influxdb-database-plugin
verifyConnection: false
allowedRoles:
- obco-influx
passwordSecretRef:
name: obco-db-root
key: password
influxdb:
host: influxdb.openbao-config.svc
port: 8086
username: admin
tls: true
insecureTLS: false
tlsMinVersion: tls12
pemJSONSecretRef:
name: obco-db-tls
key: issue.json
connectTimeout: 5s
usernameTemplate: '{{ .RoleName }}_{{ random 8 }}'
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseConnection
metadata:
name: obco-valkey
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: database
pluginName: valkey-database-plugin
verifyConnection: false
allowedRoles:
- obco-cache
passwordSecretRef:
name: obco-db-root
key: password
valkey:
host: valkey.openbao-config.svc
port: 6379
username: default
tls: true
insecureTLS: false
caCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1jYS1ub3QtcmVhbA==
-----END CERTIFICATE-----
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseConnection
metadata:
name: obco-redis-url
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: database
pluginName: redis-database-plugin
verifyConnection: false
valkey:
connectionURL: rediss://redis.openbao-config.svc:6379
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseConnection
metadata:
name: obco-snowflake
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: database
pluginName: snowflake-database-plugin
pluginVersion: v0.13.0
verifyConnection: false
allowedRoles:
- obco-analytics
privateKeySecretRef:
name: obco-db-root
key: private-key
pluginConfig:
connection_url: '{{username}}@obco-account/analytics'
username: OPENBAO_ROOT
max_open_connections: "4"
# DatabaseConnection (secrets.openbaoconfig.io/v1alpha1)
# DatabaseConnection manages a connection of a database secrets engine at `<mount>/config/<name>`: the plugin, the
# root credentials (from a Secret) and the roles allowed to 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef, mountPath,
# pluginName.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#databaseconnection
# Curated example: examples/secrets/databaseconnection.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseConnection
metadata:
name: example
namespace: openbao-config
spec:
allowedRoles:
- example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: example
name: example
namespace: example
passwordPolicy: default
passwordSecretRef:
key: value
name: databaseconnection-password-secret-ref
pluginConfig:
example: example
pluginName: postgresql-database-plugin
pluginVersion: v0.0.0
postgresql:
connectionURL: https://openbao.example.com:8200
disableEscaping: true
maxConnectionLifetime: 1h
maxIdleConnections: 1
maxOpenConnections: 1
passwordAuthentication: password
username: example
usernameTemplate: example
privateKeySecretRef:
key: value
name: databaseconnection-private-key-secret-ref
rootRotationStatements:
- example
rotateRootOnCreate: true
verifyConnection: true
---
apiVersion: v1
kind: Secret
metadata:
name: databaseconnection-password-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
name: databaseconnection-private-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
DatabaseRole¶
A dynamic role that creates a read-only PostgreSQL user per request, valid for an hour, and drops it when the lease ends.
# A dynamic role that creates a read-only PostgreSQL user per request, valid for an hour, and drops it when the lease
# ends.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseRole
metadata:
name: obco-app-ro
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: database
name: obco-app-ro
dbName: postgres
credentialType: password
credentialConfig:
password_policy: obco-db
defaultTTL: 1h
maxTTL: 24h
creationStatements:
- CREATE ROLE "{{name}}" WITH LOGIN PASSWORD '{{password}}' VALID UNTIL '{{expiration}}';
- GRANT SELECT ON ALL TABLES IN SCHEMA public TO "{{name}}";
revocationStatements:
- REVOKE ALL ON ALL TABLES IN SCHEMA public FROM "{{name}}";
- DROP ROLE IF EXISTS "{{name}}";
rollbackStatements:
- DROP ROLE IF EXISTS "{{name}}";
renewStatements:
- ALTER ROLE "{{name}}" VALID UNTIL '{{expiration}}';
---
apiVersion: v1
kind: Secret
metadata:
name: obco-db-client-ca
namespace: openbao-config
type: Opaque
stringData:
key: fake-ca-private-key-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseRole
metadata:
name: obco-app-cert
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: database
name: obco-app-cert
dbName: postgres
credentialType: client_certificate
credentialConfig:
ca_cert: fake-ca-certificate-not-real
common_name_template: "{{.DisplayName}}_{{.RoleName}}"
key_type: ec
key_bits: "256"
signature_bits: "256"
caPrivateKeySecretRef:
name: obco-db-client-ca
key: key
defaultTTL: 1h
maxTTL: 24h
creationStatements:
- CREATE ROLE "{{name}}" WITH LOGIN;
revocationStatements:
- DROP ROLE IF EXISTS "{{name}}";
# DatabaseRole (secrets.openbaoconfig.io/v1alpha1)
# DatabaseRole manages a dynamic role of a database secrets engine at `<mount>/roles/<name>`: OpenBao creates a
# short-lived database user per request (`<mount>/creds/<name>`) with the creation statements.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef, dbName,
# mountPath.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#databaserole
# Curated example: examples/secrets/databaserole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseRole
metadata:
name: example
namespace: openbao-config
spec:
caPrivateKeySecretRef:
key: value
name: databaserole-ca-private-key-secret-ref
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
creationStatements:
- example
credentialConfig:
example: example
credentialType: client_certificate
dbName: example
defaultTTL: 1h
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
maxTTL: 1h
mountPath: example
name: example
namespace: example
renewStatements:
- example
revocationStatements:
- example
rollbackStatements:
- example
---
apiVersion: v1
kind: Secret
metadata:
name: databaserole-ca-private-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseStaticRole
metadata:
name: obco-app-static
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: database
name: obco-app-static
dbName: postgres
username: obco_app
rotationPeriod: 24h
rotationStatements:
- ALTER USER "{{name}}" WITH PASSWORD '{{password}}';
credentialType: password
credentialConfig:
password_policy: obco-db
# DatabaseStaticRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef, dbName,
# mountPath, rotationPeriod, username.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#databasestaticrole
# Curated example: examples/secrets/databasestaticrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: DatabaseStaticRole
metadata:
name: example
namespace: openbao-config
spec:
caPrivateKeySecretRef:
key: value
name: databasestaticrole-ca-private-key-secret-ref
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
credentialConfig:
example: example
credentialType: client_certificate
dbName: example
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: example
name: example
namespace: example
rotationPeriod: 1h
rotationStatements:
- example
username: example
---
apiVersion: v1
kind: Secret
metadata:
name: databasestaticrole-ca-private-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GCPImpersonatedAccount
metadata:
name: obco-gcp-ci-runner
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: gcp
name: ci-runner
serviceAccountEmail: ci-runner@example-project.iam.gserviceaccount.com
tokenScopes:
- https://www.googleapis.com/auth/cloud-platform
ttl: 1h
# GCPImpersonatedAccount (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, serviceAccountEmail, tokenScopes.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#gcpimpersonatedaccount
# Curated example: examples/secrets/gcpimpersonatedaccount.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GCPImpersonatedAccount
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: gcp
name: example
namespace: example
serviceAccountEmail: user@example.com
tokenScopes:
- example
ttl: 1h
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GCPRoleset
metadata:
name: obco-gcp-viewer
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: gcp
name: viewer
secretType: access_token
project: example-project
bindings:
- resource: //cloudresourcemanager.googleapis.com/projects/example-project
roles:
- roles/viewer
- roles/browser
- resource: projects/example-project/topics/obco-events
roles:
- roles/pubsub.publisher
tokenScopes:
- https://www.googleapis.com/auth/cloud-platform
# GCPRoleset (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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: bindings, connectionRef, project.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#gcproleset
# Curated example: examples/secrets/gcproleset.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GCPRoleset
metadata:
name: example
namespace: openbao-config
spec:
bindings:
- resource: example
roles:
- example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: gcp
name: example
namespace: example
project: example
secretType: access_token
tokenScopes:
- example
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.
apiVersion: v1
kind: Secret
metadata:
name: obco-gcp-sa
namespace: openbao-config
type: Opaque
stringData:
credentials.json: '{"type":"service_account","project_id":"example-project","private_key":"fake-not-real","client_email":"openbao@example-project.iam.gserviceaccount.com"}'
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GCPSecretsConfig
metadata:
name: obco-gcp
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: gcp
credentialsSecretRef:
name: obco-gcp-sa
key: credentials.json
ttl: 1h
maxTTL: 24h
# GCPSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# GCPSecretsConfig sets the configuration of a GCP secrets engine (external plugin) at `<mount>/config`: the service
# account credentials OpenBao uses and the lease limits.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#gcpsecretsconfig
# Curated example: examples/secrets/gcpsecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GCPSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
credentialsSecretRef:
key: value
name: gcpsecretsconfig-credentials-secret-ref
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
maxTTL: 1h
mountPath: gcp
namespace: example
ttl: 1h
---
apiVersion: v1
kind: Secret
metadata:
name: gcpsecretsconfig-credentials-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GCPStaticAccount
metadata:
name: obco-gcp-ci-deployer
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: gcp
name: ci-deployer
secretType: access_token
serviceAccountEmail: ci-deployer@example-project.iam.gserviceaccount.com
bindings:
- resource: //storage.googleapis.com/projects/_/buckets/obco-artifacts
roles:
- roles/storage.objectViewer
tokenScopes:
- https://www.googleapis.com/auth/cloud-platform
# GCPStaticAccount (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, serviceAccountEmail.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#gcpstaticaccount
# Curated example: examples/secrets/gcpstaticaccount.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GCPStaticAccount
metadata:
name: example
namespace: openbao-config
spec:
bindings:
- resource: example
roles:
- example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: gcp
name: example
namespace: example
secretType: access_token
serviceAccountEmail: user@example.com
tokenScopes:
- example
GitHubSecretsConfig¶
GitHubSecretsConfig sets the GitHub App of a GitHub secrets plugin mount (external plugin) at <mount>/config.
apiVersion: v1
kind: Secret
metadata:
name: github-app-key
type: Opaque
stringData:
private-key.pem: fake-github-app-rsa-key-pem
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GitHubSecretsConfig
metadata:
name: github
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: github
appID: 123456
privateKeySecretRef:
name: github-app-key
key: private-key.pem
baseURL: https://github.example.com/api/v3
excludeRepositoryMetadata: true
# GitHubSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# GitHubSecretsConfig sets the GitHub App of a GitHub secrets plugin mount (external plugin) at `<mount>/config`.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: appID, connectionRef,
# privateKeySecretRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#githubsecretsconfig
# Curated example: examples/secrets/githubsecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GitHubSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
appID: 1
baseURL: https://openbao.example.com:8200
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
excludeRepositoryMetadata: true
managementPolicy: Manage
mountPath: github
namespace: example
privateKeySecretRef:
key: value
name: githubsecretsconfig-private-key-secret-ref
---
apiVersion: v1
kind: Secret
metadata:
name: githubsecretsconfig-private-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GitHubSecretsRole
metadata:
name: ci-read-contents
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: github
name: ci-read-contents
installationID: 7654321
organizationName: example-org
repositories:
- platform-config
- platform-charts
repositoryIDs:
- 101
- 202
permissions:
contents: read
metadata: read
pull_requests: write
skipInaccessibleRepositories: false
# GitHubSecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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/secrets/#githubsecretsrole
# Curated example: examples/secrets/githubsecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: GitHubSecretsRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
installationID: 1
managementPolicy: Manage
mountPath: github
name: example
namespace: example
organizationName: example
permissions:
example: example
repositories:
- example
repositoryIDs:
- 1
skipInaccessibleRepositories: true
KVConfig¶
Keeps ten versions of every secret on the secret mount and deletes versions older than 32 days.
# Keeps ten versions of every secret on the secret mount and deletes versions older than 32 days.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KVConfig
metadata:
name: obco-secret-config
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: secret
maxVersions: 10
casRequired: false
metadataCASRequired: false
deleteVersionAfter: 768h
# KVConfig (secrets.openbaoconfig.io/v1alpha1)
# KVConfig sets the engine-wide configuration of a KV version 2 secrets engine at `<mount>/config`: version retention
# and check-and-set enforcement.
#
# 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, mountPath.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#kvconfig
# Curated example: examples/secrets/kvconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KVConfig
metadata:
name: example
namespace: openbao-config
spec:
casRequired: true
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deleteVersionAfter: 1
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
maxVersions: 1
metadataCASRequired: true
mountPath: example
namespace: example
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.
# 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. The annotation allows deletionPolicy Delete to remove the secret data.
apiVersion: v1
kind: Secret
metadata:
name: obco-app-db
namespace: openbao-config
type: Opaque
stringData:
username: app
password: fake-db-password-not-real
---
apiVersion: v1
kind: Secret
metadata:
name: obco-app-api
namespace: openbao-config
type: Opaque
stringData:
token: fake-api-token-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KVSecret
metadata:
name: obco-app
namespace: openbao-config
annotations:
openbaoconfig.io/allow-destructive-delete: "true"
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: secret
path: obco/app
kvVersion: 2
dataFrom:
- secretRef:
name: obco-app-db
data:
api-token:
secretKeyRef:
name: obco-app-api
key: token
# KVSecret (secrets.openbaoconfig.io/v1alpha1)
# KVSecret writes a secret to a KV secrets engine at `<mount>/data/<path>` (version 2) or `<mount>/<path>` (version
# 1), with values read from Kubernetes Secrets.
#
# 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, mountPath, path.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#kvsecret
# Curated example: examples/secrets/kvsecret.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KVSecret
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
data:
example:
secretKeyRef:
key: value
name: example
dataFrom:
- secretRef:
name: kvsecret-secret-ref
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
kvVersion: 2
managementPolicy: Manage
mountPath: example
namespace: example
path: example
KVSecretMetadata¶
Per-secret KV version 2 metadata for team/app on the secret mount.
# Per-secret KV version 2 metadata for team/app on the secret mount.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KVSecretMetadata
metadata:
name: team-app
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: secret
path: team/app
maxVersions: 5
customMetadata:
owner: team
# KVSecretMetadata (secrets.openbaoconfig.io/v1alpha1)
# KVSecretMetadata sets the per-secret metadata of one KV version 2 secret at `<mount>/metadata/<path>`: version
# retention, check-and-set and custom metadata.
#
# 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, mountPath, path.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#kvsecretmetadata
# Curated example: examples/secrets/kvsecretmetadata.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KVSecretMetadata
metadata:
name: example
namespace: openbao-config
spec:
casRequired: true
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
customMetadata:
example: example
deleteVersionAfter: 1
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
maxVersions: 1
metadataCASRequired: true
mountPath: example
namespace: example
path: example
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.
apiVersion: v1
kind: Secret
metadata:
name: obco-k8s-secrets-sa
namespace: openbao-config
type: Opaque
stringData:
token: fake.service-account.jwt-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KubernetesSecretsConfig
metadata:
name: obco-kubernetes
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: kubernetes
kubernetesHost: https://kubernetes.default.svc:443
kubernetesCACert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1jYS1ub3QtcmVhbA==
-----END CERTIFICATE-----
serviceAccountJWTSecretRef:
name: obco-k8s-secrets-sa
key: token
disableLocalCAJWT: true
# KubernetesSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef, mountPath.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#kubernetessecretsconfig
# Curated example: examples/secrets/kubernetessecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KubernetesSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
disableLocalCAJWT: true
driftDetection: Enabled
driftInterval: 1h
kubernetesCACert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
kubernetesHost: https://openbao.example.com:8200
managementPolicy: Manage
mountPath: example
namespace: example
serviceAccountJWTSecretRef:
key: value
name: kubernetessecretsconfig-service-account-jwt-secret-ref
---
apiVersion: v1
kind: Secret
metadata:
name: kubernetessecretsconfig-service-account-jwt-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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>).
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KubernetesSecretsRole
metadata:
name: obco-app-sa
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: kubernetes
name: obco-app-sa
allowedKubernetesNamespaces:
- openbao-config
tokenDefaultTTL: 1h
tokenMaxTTL: 4h
tokenDefaultAudiences:
- https://kubernetes.default.svc
serviceAccountName: obco-app
kubernetesRoleType: Role
nameTemplate: '{{ printf "obco-%s-%s" (.RoleName | truncate 16) (random 8) | lowercase }}'
extraLabels:
app.kubernetes.io/managed-by: openbao
extraAnnotations:
obco.example/owner: platform
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KubernetesSecretsRole
metadata:
name: obco-app-generated
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: kubernetes
allowedKubernetesNamespaceSelector: '{"matchLabels":{"obco.example/tenant":"sandbox"}}'
kubernetesRoleType: ClusterRole
generatedRoleRules: |
rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get", "list"]
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KubernetesSecretsRole
metadata:
name: obco-app-bound
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: kubernetes
allowedKubernetesNamespaces:
- openbao-config
kubernetesRoleName: obco-app-reader
# KubernetesSecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`).
#
# 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, mountPath.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#kubernetessecretsrole
# Curated example: examples/secrets/kubernetessecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: KubernetesSecretsRole
metadata:
name: example
namespace: openbao-config
spec:
allowedKubernetesNamespaceSelector: example
allowedKubernetesNamespaces:
- example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
extraAnnotations:
example: example
extraLabels:
example: example
kubernetesRoleType: Role
managementPolicy: Manage
mountPath: example
name: example
nameTemplate: example
namespace: example
serviceAccountName: example
tokenDefaultAudiences:
- example
tokenDefaultTTL: 1h
tokenMaxTTL: 1h
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.
apiVersion: v1
kind: Secret
metadata:
name: ldap-bind
type: Opaque
stringData:
password: fake-bind-password
tls.key: fake-ldap-client-key-pem
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: LDAPSecretsConfig
metadata:
name: ldap
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: ldap
bindDN: cn=openbao,ou=services,dc=example,dc=org
bindPassSecretRef:
name: ldap-bind
key: password
url: ldaps://ldap1.example.org,ldaps://ldap2.example.org
userDN: ou=people,dc=example,dc=org
userAttr: uid
upnDomain: example.org
certificate: |
-----BEGIN CERTIFICATE-----
ZmFrZS1sZGFwLWNh
-----END CERTIFICATE-----
clientTLSCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1sZGFwLWNsaWVudC1jZXJ0
-----END CERTIFICATE-----
clientTLSKeySecretRef:
name: ldap-bind
key: tls.key
insecureTLS: false
startTLS: false
tlsMinVersion: tls12
tlsMaxVersion: tls13
connectionTimeout: 30s
requestTimeout: 1m30s
passwordPolicy: ldap-passwords
schema: openldap
skipStaticRoleImportRotation: true
# LDAPSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: bindDN, bindPassSecretRef,
# connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#ldapsecretsconfig
# Curated example: examples/secrets/ldapsecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: LDAPSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
bindDN: cn=example,dc=example,dc=com
bindPassSecretRef:
key: value
name: ldapsecretsconfig-bind-pass-secret-ref
certificate: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
clientTLSCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
clientTLSKeySecretRef:
key: value
name: ldapsecretsconfig-client-tls-key-secret-ref
connectionRef:
kind: OpenBaoConnection
name: openbao
connectionTimeout: 1h
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
insecureTLS: true
managementPolicy: Manage
mountPath: ldap
namespace: example
passwordPolicy: default
requestTimeout: 1h
schema: openldap
skipStaticRoleImportRotation: true
startTLS: true
tlsMaxVersion: tls10
tlsMinVersion: tls10
upnDomain: example
url: https://openbao.example.com:8200
userAttr: example
userDN: cn=example,dc=example,dc=com
---
apiVersion: v1
kind: Secret
metadata:
name: ldapsecretsconfig-bind-pass-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
name: ldapsecretsconfig-client-tls-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: LDAPSecretsDynamicRole
metadata:
name: app-readers
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: ldap
name: app-readers
creationLDIF: |
dn: cn={{.Username}},ou=dynamic,dc=example,dc=org
objectClass: person
objectClass: top
cn: {{.Username}}
sn: {{.Username}}
userPassword: {{.Password}}
dn: cn=readers,ou=groups,dc=example,dc=org
changetype: modify
add: member
member: cn={{.Username}},ou=dynamic,dc=example,dc=org
deletionLDIF: |
dn: cn={{.Username}},ou=dynamic,dc=example,dc=org
changetype: delete
rollbackLDIF: |
dn: cn={{.Username}},ou=dynamic,dc=example,dc=org
changetype: delete
usernameTemplate: 'v_{{.RoleName}}_{{random 10}}'
defaultTTL: 1h
maxTTL: 24h
# LDAPSecretsDynamicRole (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, creationLDIF, deletionLDIF.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#ldapsecretsdynamicrole
# Curated example: examples/secrets/ldapsecretsdynamicrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: LDAPSecretsDynamicRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationLDIF: example
creationPolicy: Create
defaultTTL: 1h
deletionLDIF: example
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
maxTTL: 1h
mountPath: ldap
name: example
namespace: example
rollbackLDIF: example
usernameTemplate: example
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: LDAPSecretsStaticRole
metadata:
name: backup-service
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: ldap
name: backup-service
username: svc-backup
dn: cn=svc-backup,ou=services,dc=example,dc=org
rotationPeriod: 24h
skipImportRotation: false
# LDAPSecretsStaticRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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, rotationPeriod, username.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#ldapsecretsstaticrole
# Curated example: examples/secrets/ldapsecretsstaticrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: LDAPSecretsStaticRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
dn: cn=example,dc=example,dc=com
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: ldap
name: example
namespace: example
rotationPeriod: 1h
skipImportRotation: true
username: example
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.
apiVersion: v1
kind: Secret
metadata:
name: atlas-api-key
type: Opaque
stringData:
private-key: fake-atlas-private-key
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: MongoDBAtlasSecretsConfig
metadata:
name: mongodbatlas
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: mongodbatlas
publicKey: fakepubkey
privateKeySecretRef:
name: atlas-api-key
key: private-key
# MongoDBAtlasSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef,
# privateKeySecretRef, publicKey.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#mongodbatlassecretsconfig
# Curated example: examples/secrets/mongodbatlassecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: MongoDBAtlasSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: mongodbatlas
namespace: example
privateKeySecretRef:
key: value
name: mongodbatlassecretsconfig-private-key-secret-ref
publicKey: |
-----BEGIN PUBLIC KEY-----
ZmFrZS1ub3QtYS1rZXk=
-----END PUBLIC KEY-----
---
apiVersion: v1
kind: Secret
metadata:
name: mongodbatlassecretsconfig-private-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: MongoDBAtlasSecretsRole
metadata:
name: project-reader
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: mongodbatlas
name: project-reader
organizationID: 5b23ff2f96e82130d0aaec13
projectID: 5cf5a45a9ccf6400e60981b6
roles:
- ORG_MEMBER
ipAddresses:
- 192.0.2.10
cidrBlocks:
- 198.51.100.0/24
projectRoles:
- GROUP_READ_ONLY
ttl: 1h
maxTTL: 24h
# MongoDBAtlasSecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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, roles.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#mongodbatlassecretsrole
# Curated example: examples/secrets/mongodbatlassecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: MongoDBAtlasSecretsRole
metadata:
name: example
namespace: openbao-config
spec:
cidrBlocks:
- 10.0.0.0/8
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
ipAddresses:
- https://openbao.example.com:8200
managementPolicy: Manage
maxTTL: 1h
mountPath: mongodbatlas
name: example
namespace: example
organizationID: example
projectID: example
projectRoles:
- example
roles:
- example
ttl: 1h
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.
apiVersion: v1
kind: Secret
metadata:
name: nomad-access
type: Opaque
stringData:
token: 00000000-0000-0000-0000-000000000000
client.key: fake-nomad-client-key-pem
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: NomadSecretsConfig
metadata:
name: nomad
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: nomad
address: https://nomad.example.org:4646
tokenSecretRef:
name: nomad-access
key: token
maxTokenNameLength: 64
caCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub21hZC1jYQ==
-----END CERTIFICATE-----
clientCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub21hZC1jbGllbnQtY2VydA==
-----END CERTIFICATE-----
clientKeySecretRef:
name: nomad-access
key: client.key
ttl: 1h
maxTTL: 24h
# NomadSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: address, connectionRef,
# tokenSecretRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#nomadsecretsconfig
# Curated example: examples/secrets/nomadsecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: NomadSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
address: https://openbao.example.com:8200
caCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
clientCert: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
clientKeySecretRef:
key: value
name: nomadsecretsconfig-client-key-secret-ref
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
maxTTL: 1h
maxTokenNameLength: 1
mountPath: nomad
namespace: example
tokenSecretRef:
key: value
name: nomadsecretsconfig-token-secret-ref
ttl: 1h
---
apiVersion: v1
kind: Secret
metadata:
name: nomadsecretsconfig-client-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
name: nomadsecretsconfig-token-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: NomadSecretsRole
metadata:
name: deployer
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: nomad
name: deployer
type: client
global: true
policies:
- deploy-jobs
- read-nodes
# NomadSecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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/secrets/#nomadsecretsrole
# Curated example: examples/secrets/nomadsecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: NomadSecretsRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
global: true
managementPolicy: Manage
mountPath: nomad
name: example
namespace: example
policies:
- default
type: client
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIACMEConfig
metadata:
name: obco-pki-int
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: obco-pki-int
enabled: true
allowedIssuers:
- obco-int-2026
allowedRoles:
- obco-acme
allowRoleExtKeyUsage: false
defaultDirectoryPolicy: role:obco-acme
dnsResolver: ""
eabPolicy: not-required
# PKIACMEConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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/secrets/#pkiacmeconfig
# Curated example: examples/secrets/pkiacmeconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIACMEConfig
metadata:
name: example
namespace: openbao-config
spec:
allowRoleExtKeyUsage: true
allowedIssuers:
- https://openbao.example.com:8200
allowedRoles:
- example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
defaultDirectoryPolicy: forbid
deletionPolicy: Orphan
dnsResolver: example
driftDetection: Enabled
driftInterval: 1h
eabPolicy: not-required
enabled: true
managementPolicy: Manage
mountPath: pki
namespace: example
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIAutoTidy
metadata:
name: obco-pki-int
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: obco-pki-int
enabled: true
intervalDuration: 12h
tidyCertStore: true
tidyRevokedCerts: true
tidyInvalidCerts: false
tidyRevokedCertIssuerAssociations: true
tidyExpiredIssuers: true
tidyMoveLegacyCABundle: false
tidyACME: true
safetyBuffer: 72h
revokedSafetyBuffer: 72h
issuerSafetyBuffer: 8760h
acmeAccountSafetyBuffer: 720h
pageSize: 1000
pauseDuration: 0s
maintainStoredCertificateCounts: true
publishStoredCertificateCountMetrics: true
# PKIAutoTidy (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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/secrets/#pkiautotidy
# Curated example: examples/secrets/pkiautotidy.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIAutoTidy
metadata:
name: example
namespace: openbao-config
spec:
acmeAccountSafetyBuffer: 1h
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
enabled: true
intervalDuration: 1h
issuerSafetyBuffer: 1h
maintainStoredCertificateCounts: true
managementPolicy: Manage
mountPath: pki
namespace: example
pageSize: 5
pauseDuration: 1h
publishStoredCertificateCountMetrics: true
revokedSafetyBuffer: 1h
safetyBuffer: 1h
tidyACME: true
tidyCertStore: true
tidyExpiredIssuers: true
tidyInvalidCerts: true
tidyMoveLegacyCABundle: true
tidyRevokedCertIssuerAssociations: true
tidyRevokedCerts: true
PKICELRole¶
CEL policy for certificate issuance on the default pki mount.
# CEL policy for certificate issuance on the default pki mount.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKICELRole
metadata:
name: strict-cn
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: pki
celProgram:
expression: "success ? output : err"
variables:
- name: require_ip_sans
expression: size(request.ip_sans) > 0
- name: success
expression: request.common_name == 'example.com' && require_ip_sans
- name: cert
expression: 'CertTemplate{Subject: PKIX.Name{CommonName: request.common_name, Country: ["ZW", "US"]}}'
- name: output
expression: "ValidationOutput{template: cert}"
- name: err
expression: "'Request should have atleast 1 IP SAN.'"
# PKICELRole (secrets.openbaoconfig.io/v1alpha1)
# PKICELRole manages a CEL-backed PKI role at `<mountPath>/cel/roles/<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: celProgram, connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#pkicelrole
# Curated example: examples/secrets/pkicelrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKICELRole
metadata:
name: example
namespace: openbao-config
spec:
celProgram:
expression: example
variables:
- expression: example
name: example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: pki
name: example
namespace: example
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).
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIConfig
metadata:
name: obco-pki-int
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: obco-pki-int
cluster:
path: https://openbao.openbao-config.example.com/v1/openbao-config/obco-pki-int
aiaPath: http://openbao.openbao-config.example.com/v1/openbao-config/obco-pki-int
urls:
issuingCertificates:
- "{{cluster_aia_path}}/issuer/{{issuer_id}}/der"
crlDistributionPoints:
- "{{cluster_aia_path}}/issuer/{{issuer_id}}/crl/der"
deltaCRLDistributionPoints:
- "{{cluster_aia_path}}/issuer/{{issuer_id}}/crl/delta/der"
ocspServers:
- "{{cluster_path}}/ocsp"
enableTemplating: true
crl:
expiry: 72h
disable: false
ocspDisable: false
ocspExpiry: 12h
autoRebuild: true
autoRebuildGracePeriod: 12h
enableDelta: true
deltaRebuildInterval: 15m
allowExpiredCertRevocation: false
issuers:
default:
issuerRef:
name: obco-int-2026
defaultFollowsLatestIssuer: false
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIConfig
metadata:
name: obco-pki-root
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: obco-pki-root
issuers:
default:
issuerName: obco-root-2026
# PKIConfig (secrets.openbaoconfig.io/v1alpha1)
# 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`).
#
# 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/secrets/#pkiconfig
# Curated example: examples/secrets/pkiconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIConfig
metadata:
name: example
namespace: openbao-config
spec:
cluster:
aiaPath: https://openbao.example.com:8200
path: https://openbao.example.com:8200
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
crl:
allowExpiredCertRevocation: true
autoRebuild: true
autoRebuildGracePeriod: 1h
deltaRebuildInterval: 1h
disable: true
enableDelta: true
expiry: 1h
ocspDisable: true
ocspExpiry: 1h
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
issuers:
default:
issuerName: https://openbao.example.com:8200
defaultFollowsLatestIssuer: true
managementPolicy: Manage
mountPath: pki
namespace: example
urls:
crlDistributionPoints:
- example
deltaCRLDistributionPoints:
- example
enableTemplating: true
issuingCertificates:
- |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
ocspServers:
- example
PKIIssuer¶
Generates an EC P-384 root CA issuer inside OpenBao on the obco-pki-root mount.
# Generates an EC P-384 root CA issuer inside OpenBao on the obco-pki-root mount.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIIssuer
metadata:
name: obco-root-2026
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: obco-pki-root
name: obco-root-2026
type: root
key:
source: internal
name: obco-root-2026-key
type: ec
bits: 384
certificate:
commonName: OBCO Sandbox Root CA 2026
altNames:
- root-ca.openbao-config.example.com
- pki@openbao-config.example.com
ipSANs:
- 192.0.2.10
uriSANs:
- spiffe://openbao-config.example.com/ca/root
otherSANs:
- 1.3.6.1.4.1.311.20.2.3;UTF8:root-ca@openbao-config.example.com
excludeCNFromSANs: true
ou:
- Platform
organization:
- OBCO Sandbox
country:
- DE
locality:
- Berlin
province:
- Berlin
streetAddress:
- Example Street 1
postalCode:
- "10115"
serialNumber: obco-root-2026
ttl: 87600h
notBeforeDuration: 30s
maxPathLength: 1
permittedDNSDomains:
- openbao-config.example.com
signatureBits: 384
usePSS: false
leafNotAfterBehavior: err
usage:
- issuing-certificates
- crl-signing
- ocsp-signing
manualChain:
- obco-root-2026
revocationSignatureAlgorithm: ECDSAWithSHA384
issuingCertificates:
- https://openbao.openbao-config.example.com/v1/openbao-config/obco-pki-root/issuer/obco-root-2026/der
crlDistributionPoints:
- https://openbao.openbao-config.example.com/v1/openbao-config/obco-pki-root/issuer/obco-root-2026/crl/der
ocspServers:
- https://openbao.openbao-config.example.com/v1/openbao-config/obco-pki-root/ocsp
enableAIAURLTemplating: false
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIIssuer
metadata:
name: obco-int-2026
namespace: openbao-config
spec:
connectionRef:
name: openbao
deletionPolicy: Orphan
mountPath: obco-pki-int
type: intermediate
key:
source: exported
name: obco-int-2026-key
type: ec
bits: 256
privateKeyFormat: pkcs8
certificate:
commonName: OBCO Sandbox Intermediate CA 2026
organization:
- OBCO Sandbox
notAfter: "2031-01-01T00:00:00Z"
maxPathLength: 0
permittedDNSDomains:
- openbao-config.example.com
addBasicConstraints: false
signer:
issuerRef:
name: obco-root-2026
writeSecretRef:
name: obco-int-2026-private-key
leafNotAfterBehavior: truncate
usage:
- issuing-certificates
- crl-signing
enableAIAURLTemplating: true
issuingCertificates:
- "{{cluster_aia_path}}/issuer/{{issuer_id}}/der"
crlDistributionPoints:
- "{{cluster_aia_path}}/issuer/{{issuer_id}}/crl/der"
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIIssuer
metadata:
name: obco-int-2026b
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: obco-pki-int
type: intermediate
key:
source: existing
existing:
keyRef:
name: obco-int-key
certificate:
commonName: OBCO Sandbox Intermediate CA 2026b
ttl: 43800h
signer:
mountPath: obco-pki-root
issuerName: obco-root-2026
# PKIIssuer (secrets.openbaoconfig.io/v1alpha1)
# PKIIssuer manages a root or intermediate CA issuer of a PKI secrets engine at `<mount>/issuer/<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: certificate, connectionRef, type.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#pkiissuer
# Curated example: examples/secrets/pkiissuer.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIIssuer
metadata:
name: example
namespace: openbao-config
spec:
certificate:
altNames:
- example
commonName: example
country:
- example
excludeCNFromSANs: true
ipSANs:
- example
locality:
- example
maxPathLength: 1
notBeforeDuration: 1h
organization:
- example
otherSANs:
- example
ou:
- example
permittedDNSDomains:
- example
postalCode:
- example
province:
- example
serialNumber: example
signatureBits: 256
streetAddress:
- https://openbao.example.com:8200
ttl: 1h
uriSANs:
- https://openbao.example.com:8200
usePSS: true
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
crlDistributionPoints:
- example
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
enableAIAURLTemplating: true
issuingCertificates:
- |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
key:
bits: 44
name: example
privateKeyFormat: der
source: exported
type: rsa
leafNotAfterBehavior: err
managementPolicy: Manage
manualChain:
- example
mountPath: pki
name: example
namespace: example
ocspServers:
- example
revocationSignatureAlgorithm: SHA256WithRSA
type: root
usage:
- read-only
writeSecretRef:
name: pkiissuer-write-secret-ref
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKey
metadata:
name: obco-int-key
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: obco-pki-int
name: obco-int-key
type: internal
keyType: ec
keyBits: 256
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKey
metadata:
name: obco-exported-key
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: obco-pki-int
type: exported
keyType: rsa
keyBits: 4096
writeSecretRef:
name: obco-exported-key-private
---
apiVersion: v1
kind: Secret
metadata:
name: obco-imported-key
namespace: openbao-config
type: Opaque
stringData:
key.pem: fake-pem-private-key-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKey
metadata:
name: obco-imported-key
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: obco-pki-int
type: import
pemBundleSecretRef:
name: obco-imported-key
key: key.pem
# PKIKey (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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/secrets/#pkikey
# Curated example: examples/secrets/pkikey.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKey
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
keyBits: 44
keyType: rsa
managementPolicy: Manage
mountPath: pki
name: example
namespace: example
type: internal
PKIKeyConfig¶
Default signing key for the pki mount; the config path cannot be deleted.
# Default signing key for the pki mount; the config path cannot be deleted.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKeyConfig
metadata:
name: pki-default-key
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: pki
defaultKey: example-key
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKey
metadata:
name: example-key
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: pki
name: example-key
type: internal
keyType: ec
keyBits: 256
# PKIKeyConfig (secrets.openbaoconfig.io/v1alpha1)
# PKIKeyConfig sets the default signing key of a PKI secrets engine at `<mountPath>/config/keys`.
#
# 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, defaultKey.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#pkikeyconfig
# Curated example: examples/secrets/pkikeyconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIKeyConfig
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
defaultKey: example
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: pki
namespace: example
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.
# 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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIRole
metadata:
name: obco-web
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: obco-pki-int
name: obco-web
issuer:
issuerRef:
name: obco-int-2026
ttl: 24h
maxTTL: 720h
allowLocalhost: false
allowedDomains:
- openbao-config.example.com
- "{{identity.entity.metadata.team}}.openbao-config.example.com"
allowedDomainsTemplate: true
allowGlobsInIdentityTemplates: false
allowBareDomains: false
allowSubdomains: true
allowGlobDomains: false
allowWildcardCertificates: false
allowAnyName: false
enforceHostnames: true
allowIPSANs: true
allowedIPSANsCIDR:
- 10.0.0.0/8
allowedURISANs:
- spiffe://openbao-config.example.com/*
allowedURISANsTemplate: false
allowedOtherSANs:
- 1.3.6.1.4.1.311.20.2.3;UTF8:*@openbao-config.example.com
allowedSerialNumbers:
- obco-*
allowedUserIDs:
- "*"
serverFlag: true
clientFlag: true
codeSigningFlag: false
emailProtectionFlag: false
keyType: ec
keyBits: 256
signatureBits: 256
usePSS: false
keyUsage:
- DigitalSignature
- KeyAgreement
extKeyUsage:
- ServerAuth
- ClientAuth
extKeyUsageOIDs:
- 1.3.6.1.5.5.7.3.1
useCSRCommonName: true
useCSRSANs: true
ou:
- Platform
organization:
- OBCO Sandbox
country:
- DE
locality:
- Berlin
province:
- Berlin
streetAddress:
- Example Street 1
postalCode:
- "10115"
generateLease: false
noStore: false
requireCN: true
cnValidations:
- hostname
policyIdentifiers:
- 1.3.6.1.4.1.44947.1.1.1
basicConstraintsValidForNonCA: false
notBeforeDuration: 30s
notBefore: "2026-01-01T00:00:00Z"
notBeforeBound: permit
notAfter: "2030-01-01T00:00:00Z"
notAfterBound: ttl-limited
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIRole
metadata:
name: obco-acme
namespace: openbao-config
spec:
connectionRef:
name: openbao
mountPath: obco-pki-int
issuer:
issuerName: obco-int-2026
allowedDomains:
- acme.openbao-config.example.com
allowSubdomains: true
maxTTL: 2160h
# PKIRole (secrets.openbaoconfig.io/v1alpha1)
# PKIRole manages a certificate role of a PKI secrets engine at `<mount>/roles/<name>`: which names, key types,
# lifetimes and usages certificates issued or signed through it (`<mount>/issue/<name>`, `<mount>/sign/<name>`) may
# have.
#
# 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/secrets/#pkirole
# Curated example: examples/secrets/pkirole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: PKIRole
metadata:
name: example
namespace: openbao-config
spec:
allowAnyName: true
allowBareDomains: true
allowGlobDomains: true
allowGlobsInIdentityTemplates: true
allowIPSANs: true
allowLocalhost: true
allowSubdomains: true
allowWildcardCertificates: true
allowedDomains:
- example
allowedDomainsTemplate: true
allowedIPSANsCIDR:
- 10.0.0.0/8
allowedOtherSANs:
- example
allowedSerialNumbers:
- example
allowedURISANs:
- https://openbao.example.com:8200
allowedURISANsTemplate: true
allowedUserIDs:
- example
basicConstraintsValidForNonCA: true
clientFlag: true
cnValidations:
- email
codeSigningFlag: true
connectionRef:
kind: OpenBaoConnection
name: openbao
country:
- example
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
emailProtectionFlag: true
enforceHostnames: true
extKeyUsage:
- ServerAuth
extKeyUsageOIDs:
- 127.0.0.1
generateLease: true
issuer:
issuerName: https://openbao.example.com:8200
keyBits: 44
keyType: mldsa
keyUsage:
- DigitalSignature
locality:
- example
managementPolicy: Manage
maxTTL: 1h
mountPath: pki
name: example
namespace: example
noStore: false
notAfter: 0000-00-00T00:00:00Z
notAfterBound: permit
notBefore: 0000-00-00T00:00:00Z
notBeforeBound: permit
notBeforeDuration: 1h
organization:
- example
ou:
- example
policyIdentifiers:
- 127.0.0.1
postalCode:
- example
province:
- example
requireCN: true
serverFlag: true
signatureBits: 256
streetAddress:
- https://openbao.example.com:8200
ttl: 1h
useCSRCommonName: true
useCSRSANs: true
usePSS: true
QuaySecretsConfig¶
QuaySecretsConfig sets the Quay instance of a Quay secrets plugin mount (external plugin) at <mount>/config, in which OpenBao creates robot accounts.
apiVersion: v1
kind: Secret
metadata:
name: quay-token
type: Opaque
stringData:
token: fake-quay-oauth-token
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: QuaySecretsConfig
metadata:
name: quay
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: quay
url: https://quay.example.org
tokenSecretRef:
name: quay-token
key: token
caCertificate: |
-----BEGIN CERTIFICATE-----
ZmFrZS1xdWF5LWNh
-----END CERTIFICATE-----
disableSSLVerification: false
# QuaySecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# QuaySecretsConfig sets the Quay instance of a Quay secrets plugin mount (external plugin) at `<mount>/config`, in
# which OpenBao creates robot accounts.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef,
# tokenSecretRef, url.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#quaysecretsconfig
# Curated example: examples/secrets/quaysecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: QuaySecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
caCertificate: |
-----BEGIN CERTIFICATE-----
ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
-----END CERTIFICATE-----
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
disableSSLVerification: true
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: quay
namespace: example
tokenSecretRef:
key: value
name: quaysecretsconfig-token-secret-ref
url: https://openbao.example.com:8200
---
apiVersion: v1
kind: Secret
metadata:
name: quaysecretsconfig-token-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: QuaySecretsRole
metadata:
name: ci-push
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: quay
name: ci-push
namespaceName: platform
namespaceType: organization
createRepositories: true
defaultPermission: read
teams:
builders: member
repositories:
platform/operator: write
platform/charts: admin
ttl: 1h
maxTTL: 24h
# QuaySecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, namespaceName.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#quaysecretsrole
# Curated example: examples/secrets/quaysecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: QuaySecretsRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
createRepositories: true
creationPolicy: Create
defaultPermission: admin
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
maxTTL: 1h
mountPath: quay
name: example
namespace: example
namespaceName: example
namespaceType: organization
repositories:
example: admin
teams:
example: admin
ttl: 1h
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: QuaySecretsStaticRole
metadata:
name: mirror-pull
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: quay
name: mirror-pull
namespaceName: platform
namespaceType: organization
createRepositories: false
defaultPermission: read
teams:
readers: member
repositories:
platform/mirror: read
# QuaySecretsStaticRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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, namespaceName.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#quaysecretsstaticrole
# Curated example: examples/secrets/quaysecretsstaticrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: QuaySecretsStaticRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
createRepositories: true
creationPolicy: Create
defaultPermission: admin
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: quay
name: example
namespace: example
namespaceName: example
namespaceType: organization
repositories:
example: admin
teams:
example: admin
RabbitMQConfig¶
RabbitMQConfig sets the connection (<mount>/config/connection) and lease settings (<mount>/config/lease) of a RabbitMQ secrets engine, which issues dynamic RabbitMQ users.
apiVersion: v1
kind: Secret
metadata:
name: obco-rabbitmq-admin
namespace: openbao-config
type: Opaque
stringData:
password: fake-rabbitmq-password-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RabbitMQConfig
metadata:
name: obco-rabbitmq
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: rabbitmq
connectionURI: http://rabbitmq.openbao-config.svc:15672
username: openbao-admin
passwordSecretRef:
name: obco-rabbitmq-admin
key: password
verifyConnection: true
passwordPolicy: obco-rabbitmq
usernameTemplate: '{{ printf "obco-%s-%s" (.RoleName | truncate 16) (random 8) }}'
lease:
ttl: 1h
maxTTL: 24h
# RabbitMQConfig (secrets.openbaoconfig.io/v1alpha1)
# RabbitMQConfig sets the connection (`<mount>/config/connection`) and lease settings (`<mount>/config/lease`) of a
# RabbitMQ secrets engine, which issues dynamic RabbitMQ users.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef, connectionURI,
# mountPath, passwordSecretRef, username.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#rabbitmqconfig
# Curated example: examples/secrets/rabbitmqconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RabbitMQConfig
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
connectionURI: https://openbao.example.com:8200
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
lease:
maxTTL: 1h
ttl: 1h
managementPolicy: Manage
mountPath: example
namespace: example
passwordPolicy: default
passwordSecretRef:
key: value
name: rabbitmqconfig-password-secret-ref
username: example
usernameTemplate: example
verifyConnection: true
---
apiVersion: v1
kind: Secret
metadata:
name: rabbitmqconfig-password-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RabbitMQRole
metadata:
name: obco-app
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: rabbitmq
name: obco-app
tags:
- management
vhosts:
/:
configure: ^obco\.
write: ^obco\.
read: .*
obco:
configure: ""
write: .*
read: .*
vhostTopics:
/:
amq.topic:
write: ^obco\.
read: .*
# RabbitMQRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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, mountPath.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#rabbitmqrole
# Curated example: examples/secrets/rabbitmqrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RabbitMQRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: example
name: example
namespace: example
tags:
- example
vhostTopics:
example:
example:
read: example
write: example
vhosts:
example:
configure: example
read: example
write: example
RandomSecret¶
Generates a session key once, stores it in KV and copies it to a Kubernetes Secret; changing refreshNonce regenerates it.
# Generates a session key once, stores it in KV and copies it to a Kubernetes Secret; changing refreshNonce
# regenerates it. The second resource generates a password from a PasswordPolicy instead.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RandomSecret
metadata:
name: obco-app-session-key
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: secret
path: obco/app-random
kvVersion: 2
key: session-key
generator:
length: 48
charset: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_
refreshNonce: "2026-11-14"
writeSecretRef:
name: obco-app-session-key
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RandomSecret
metadata:
name: obco-app-admin-password
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: secret
path: obco/app-admin
kvVersion: 2
key: admin-password
passwordPolicyName: db-passwords
refreshNonce: "1"
writeSecretRef:
name: obco-app-admin-password
# RandomSecret (secrets.openbaoconfig.io/v1alpha1)
# RandomSecret generates a value, such as a password, once and stores it under one key of a KV secret
# (`<mount>/data/<path>` on version 2).
#
# 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, mountPath, path.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#randomsecret
# Curated example: examples/secrets/randomsecret.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: RandomSecret
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
key: password
kvVersion: 2
managementPolicy: Manage
mountPath: example
namespace: example
passwordPolicyName: default
path: example
refreshNonce: example
writeSecretRef:
name: randomsecret-write-secret-ref
SSHCA¶
SSHCA configures the default signing CA of an SSH secrets engine at <mount>/config/ca, generated by OpenBao or imported from a Secret.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: SSHCA
metadata:
name: obco-ssh-ca
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: ssh
keyType: ecdsa-sha2-nistp384
keyBits: 384
---
apiVersion: v1
kind: Secret
metadata:
name: obco-ssh-ca-imported
namespace: openbao-config
type: Opaque
stringData:
private-key: fake-ssh-ca-private-key-not-real
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: SSHCA
metadata:
name: obco-ssh-ca-imported
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: ssh-imported
publicKey: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGZha2UtcHVibGljLWtleS1ub3QtcmVhbC0wMDAw obco-fake
privateKeySecretRef:
name: obco-ssh-ca-imported
key: private-key
# SSHCA (secrets.openbaoconfig.io/v1alpha1)
# SSHCA configures the default signing CA of an SSH secrets engine at `<mount>/config/ca`, generated by OpenBao or
# imported from a Secret.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#sshca
# Curated example: examples/secrets/sshca.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: SSHCA
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: ssh
namespace: example
privateKeySecretRef:
key: value
name: sshca-private-key-secret-ref
publicKey: |
-----BEGIN PUBLIC KEY-----
ZmFrZS1ub3QtYS1rZXk=
-----END PUBLIC KEY-----
---
apiVersion: v1
kind: Secret
metadata:
name: sshca-private-key-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: SSHRole
metadata:
name: obco-ssh-users
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: ssh
name: obco-users
keyType: ca
defaultUser: ubuntu
defaultUserTemplate: false
allowedUsers:
- ubuntu
- "{{identity.entity.name}}"
allowedUsersTemplate: true
allowedDomains:
- obco.example.com
allowedDomainsTemplate: false
ttl: 30m
maxTTL: 8h
allowedCriticalOptions:
- force-command
allowedExtensions:
- permit-pty
- permit-port-forwarding
defaultCriticalOptions:
force-command: /usr/bin/true
defaultExtensions:
permit-pty: ""
defaultExtensionsTemplate: false
allowUserCertificates: true
allowHostCertificates: true
allowBareDomains: false
allowSubdomains: true
allowUserKeyIDs: false
allowEmptyPrincipals: false
allowCommasInIdentityTemplates: false
allowWildcardsInIdentityTemplates: false
keyIDFormat: "{{role_name}}-{{token_display_name}}"
allowedUserKeyLengths:
rsa:
- 3072
- 4096
ed25519:
- 256
algorithmSigner: default
notBeforeDuration: 30s
issuerRef: default
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: SSHRole
metadata:
name: obco-ssh-otp
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: ssh
keyType: otp
defaultUser: ubuntu
allowedUsers:
- ubuntu
cidrList:
- 10.20.0.0/16
excludeCIDRList:
- 10.20.0.0/24
port: 2222
# SSHRole (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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, keyType.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#sshrole
# Curated example: examples/secrets/sshrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: SSHRole
metadata:
name: example
namespace: openbao-config
spec:
algorithmSigner: default
allowBareDomains: true
allowCommasInIdentityTemplates: true
allowEmptyPrincipals: true
allowHostCertificates: true
allowSubdomains: true
allowUserCertificates: true
allowUserKeyIDs: true
allowWildcardsInIdentityTemplates: true
allowedCriticalOptions:
- example
allowedDomains:
- example
allowedDomainsTemplate: true
allowedExtensions:
- example
allowedUserKeyLengths:
example:
- 1
allowedUsers:
- example
allowedUsersTemplate: true
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
defaultCriticalOptions:
example: example
defaultExtensions:
example: example
defaultExtensionsTemplate: true
defaultUser: example
defaultUserTemplate: true
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
issuerRef: example
keyIDFormat: example
keyType: ca
managementPolicy: Manage
maxTTL: 1h
mountPath: ssh
name: example
namespace: example
notBeforeDuration: 1h
ttl: 1h
TOTPKey¶
TOTPKey manages a key of a TOTP secrets engine at <mount>/keys/<name>, either generated by OpenBao or imported from a Secret.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TOTPKey
metadata:
name: obco-alice
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: totp
name: obco-alice
generate:
keySize: 20
exported: true
qrSize: 200
writeSecretRef:
name: obco-alice-otpauth
issuer: Example
accountName: alice@example.com
period: 30s
algorithm: SHA256
digits: 8
skew: 1
---
apiVersion: v1
kind: Secret
metadata:
name: obco-bob-totp
namespace: openbao-config
type: Opaque
stringData:
key: FAKEFAKEFAKEFAKE
url: otpauth://totp/Example:carol@example.com?secret=FAKEFAKEFAKEFAKE&issuer=Example&period=30&digits=6&algorithm=SHA1
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TOTPKey
metadata:
name: obco-bob
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: totp
keySecretRef:
name: obco-bob-totp
key: key
issuer: Example
accountName: bob@example.com
period: 60s
algorithm: SHA1
digits: 6
skew: 0
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TOTPKey
metadata:
name: obco-carol
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: totp
urlSecretRef:
name: obco-bob-totp
key: url
skew: 1
# TOTPKey (secrets.openbaoconfig.io/v1alpha1)
# TOTPKey manages a key of a TOTP secrets engine at `<mount>/keys/<name>`, either generated by OpenBao or imported
# from a Secret.
#
# 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/secrets/#totpkey
# Curated example: examples/secrets/totpkey.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TOTPKey
metadata:
name: example
namespace: openbao-config
spec:
accountName: example
algorithm: SHA1
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
digits: 6
driftDetection: Enabled
driftInterval: 1h
generate:
exported: true
keySize: 1
qrSize: 1
writeSecretRef:
name: totpkey-write-secret-ref
issuer: https://openbao.example.com:8200
managementPolicy: Manage
mountPath: totp
name: example
namespace: example
period: 1h
skew: 1
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.
apiVersion: v1
kind: Secret
metadata:
name: terraform-token
type: Opaque
stringData:
token: fake.atlasv1.terraform-api-token
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TerraformCloudSecretsConfig
metadata:
name: terraform
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: terraform
address: https://tfe.example.org
basePath: /api/v2/
tokenSecretRef:
name: terraform-token
key: token
explicitMaxTTL: 8760h
# TerraformCloudSecretsConfig (secrets.openbaoconfig.io/v1alpha1)
# 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.
#
# 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.
# The Secrets after it hold fake values for the secret references. Required spec fields: connectionRef,
# tokenSecretRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#terraformcloudsecretsconfig
# Curated example: examples/secrets/terraformcloudsecretsconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TerraformCloudSecretsConfig
metadata:
name: example
namespace: openbao-config
spec:
address: https://openbao.example.com:8200
basePath: example
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
explicitMaxTTL: 1h
managementPolicy: Manage
mountPath: terraform
namespace: example
tokenSecretRef:
key: value
name: terraformcloudsecretsconfig-token-secret-ref
---
apiVersion: v1
kind: Secret
metadata:
name: terraformcloudsecretsconfig-token-secret-ref
namespace: openbao-config
stringData:
value: fake-value-not-a-secret
type: Opaque
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>.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TerraformCloudSecretsRole
metadata:
name: platform-team
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: terraform
name: platform-team
organization: example-org
teamID: team-fakefakefake0001
credentialType: team
description: openbao-platform
ttl: 1h
maxTTL: 24h
# TerraformCloudSecretsRole (secrets.openbaoconfig.io/v1alpha1)
# 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>`.
#
# 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/secrets/#terraformcloudsecretsrole
# Curated example: examples/secrets/terraformcloudsecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TerraformCloudSecretsRole
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
credentialType: organization
deletionPolicy: Orphan
description: example
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
maxTTL: 1h
mountPath: terraform
name: example
namespace: example
organization: example
teamID: example
ttl: 1h
TransitCacheConfig¶
Bound the Transit cache to 100 entries; use size 0 for an unlimited cache.
# Bound the Transit cache to 100 entries; use size 0 for an unlimited cache.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitCacheConfig
metadata:
name: obco-transit-cache
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: transit
size: 100
# TransitCacheConfig (secrets.openbaoconfig.io/v1alpha1)
# TransitCacheConfig sets the encryption-cache configuration of a Transit secrets engine at `<mount>/cache-config`.
#
# 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, mountPath.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#transitcacheconfig
# Curated example: examples/secrets/transitcacheconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitCacheConfig
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: example
namespace: example
size: 0
TransitKey¶
An AES-256-GCM transit key for application encryption that rotates every 30 days, plus an HMAC key.
# An AES-256-GCM transit key for application encryption that rotates every 30 days, plus an HMAC key.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitKey
metadata:
name: obco-app-encryption
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: transit
name: obco-app
type: aes256-gcm96
derived: true
convergentEncryption: true
exportable: true
allowPlaintextBackup: true
autoRotatePeriod: 720h
minDecryptionVersion: 1
minEncryptionVersion: 0
deletionAllowed: false
rotateNonce: "2026-11-14"
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitKey
metadata:
name: obco-app-hmac
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: transit
type: hmac
keySize: 64
# TransitKey (secrets.openbaoconfig.io/v1alpha1)
# TransitKey manages a named key of a transit secrets engine at `<mount>/keys/<name>`, for encryption as a service,
# signing or HMAC; its key material never leaves OpenBao unless exportable.
#
# 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/secrets/#transitkey
# Curated example: examples/secrets/transitkey.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitKey
metadata:
name: example
namespace: openbao-config
spec:
allowPlaintextBackup: true
autoRotatePeriod: 1h
connectionRef:
kind: OpenBaoConnection
name: openbao
convergentEncryption: true
creationPolicy: Create
deletionAllowed: true
deletionPolicy: Orphan
derived: true
driftDetection: Enabled
driftInterval: 1h
exportable: true
keySize: 32
managementPolicy: Manage
minDecryptionVersion: 1
minEncryptionVersion: 1
mountPath: transit
name: example
namespace: example
rotateNonce: example
type: hmac
TransitKeyConfig¶
Mount-wide transit key defaults on the transit mount.
# Mount-wide transit key defaults on the transit mount.
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitKeyConfig
metadata:
name: obco-transit-keys
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: transit
disableUpsert: false
# TransitKeyConfig (secrets.openbaoconfig.io/v1alpha1)
# TransitKeyConfig sets the mount-wide key configuration of a Transit secrets engine at `<mount>/config/keys`.
#
# 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, mountPath.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/secrets/#transitkeyconfig
# Curated example: examples/secrets/transitkeyconfig.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TransitKeyConfig
metadata:
name: example
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: Create
deletionPolicy: Orphan
disableUpsert: true
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
mountPath: example
namespace: example