Skip to content

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

AWSAuthCertificate

AWSAuthCertificate manages an AWS public certificate of an OpenBao AWS auth method at auth/<mountPath>/config/certificate/<name>.

API reference

examples/auth/awsauthcertificate.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthCertificate
metadata:
  name: aws-cert-eu-central-1
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: aws
  name: eu-central-1-pkcs7
  awsPublicCert: |
    -----BEGIN CERTIFICATE-----
    MIIBfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfake
    -----END CERTIFICATE-----
  type: pkcs7
examples-generated/auth/awsauthcertificate.yaml
# AWSAuthCertificate (auth.openbaoconfig.io/v1alpha1)
# AWSAuthCertificate manages an AWS public certificate of an OpenBao AWS auth method at
# auth/<mountPath>/config/certificate/<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: awsPublicCert, connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#awsauthcertificate
# Curated example: examples/auth/awsauthcertificate.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthCertificate
metadata:
  name: example
  namespace: openbao-config
spec:
  awsPublicCert: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: aws
  name: example
  namespace: example
  type: pkcs7

AWSAuthConfig

AWSAuthConfig manages the AWS client configuration of an OpenBao AWS auth method at auth/<mountPath>/config/client.

API reference

examples/auth/awsauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthConfig
metadata:
  name: aws-client
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: aws
  accessKeySecretRef:
    name: aws-auth-credentials
    key: access-key
  secretKeySecretRef:
    name: aws-auth-credentials
    key: secret-key
  ec2Endpoint: https://ec2.eu-central-1.amazonaws.com
  iamEndpoint: https://iam.amazonaws.com
  stsEndpoint: https://sts.eu-central-1.amazonaws.com
  stsRegion: eu-central-1
  useSTSRegionFromClient: false
  iamServerIDHeaderValue: openbao.example.com
  allowedSTSHeaderValues:
    - X-Example-Trace
  maxRetries: 5
---
apiVersion: v1
kind: Secret
metadata:
  name: aws-auth-credentials
  namespace: openbao-config
type: Opaque
stringData:
  access-key: AKIAFAKEFAKEFAKEFAKE
  secret-key: fake-secret-key-not-real
examples-generated/auth/awsauthconfig.yaml
# AWSAuthConfig (auth.openbaoconfig.io/v1alpha1)
# AWSAuthConfig manages the AWS client configuration of an OpenBao AWS auth method at auth/<mountPath>/config/client.
#
# 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/auth/#awsauthconfig
# Curated example: examples/auth/awsauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  accessKeySecretRef:
    key: value
    name: awsauthconfig-access-key-secret-ref
  allowedSTSHeaderValues:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  ec2Endpoint: https://openbao.example.com:8200
  iamEndpoint: https://openbao.example.com:8200
  iamServerIDHeaderValue: example
  managementPolicy: Manage
  maxRetries: 1
  mountPath: aws
  namespace: example
  secretKeySecretRef:
    key: value
    name: awsauthconfig-secret-key-secret-ref
  stsEndpoint: https://openbao.example.com:8200
  stsRegion: example
  useSTSRegionFromClient: true
---
apiVersion: v1
kind: Secret
metadata:
  name: awsauthconfig-access-key-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
  name: awsauthconfig-secret-key-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

AWSAuthIdentityConfig

AWSAuthIdentityConfig manages how an OpenBao AWS auth method builds entity alias names and token metadata, at auth/<mountPath>/config/identity.

API reference

examples/auth/awsauthidentityconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthIdentityConfig
metadata:
  name: aws-identity
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: aws
  iamAlias: unique_id
  iamMetadata:
    - account_id
    - auth_type
  ec2Alias: instance_id
  ec2Metadata:
    - region
    - account_id
examples-generated/auth/awsauthidentityconfig.yaml
# AWSAuthIdentityConfig (auth.openbaoconfig.io/v1alpha1)
# AWSAuthIdentityConfig manages how an OpenBao AWS auth method builds entity alias names and token metadata, at
# auth/<mountPath>/config/identity.
#
# 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/auth/#awsauthidentityconfig
# Curated example: examples/auth/awsauthidentityconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthIdentityConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  ec2Alias: role_id
  ec2Metadata:
  - example
  iamAlias: role_id
  iamMetadata:
  - example
  managementPolicy: Manage
  mountPath: aws
  namespace: example

AWSAuthRole

AWSAuthRole manages a role of an OpenBao AWS auth method at auth/<mountPath>/role/<name>.

API reference

examples/auth/awsauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthRole
metadata:
  name: aws-app
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: aws
  name: app
  authType: iam
  boundAMIIDs:
    - ami-0123456789abcdef0
  boundAccountIDs:
    - "123456789012"
  boundRegions:
    - eu-central-1
  boundVPCIDs:
    - vpc-0123456789abcdef0
  boundSubnetIDs:
    - subnet-0123456789abcdef0
  boundIAMRoleARNs:
    - arn:aws:iam::123456789012:role/app
  boundIAMInstanceProfileARNs:
    - arn:aws:iam::123456789012:instance-profile/app
  boundEC2InstanceIDs:
    - i-0123456789abcdef0
  boundIAMPrincipalARNs:
    - arn:aws:iam::123456789012:role/app
  inferredEntityType: ec2_instance
  inferredAWSRegion: eu-central-1
  resolveAWSUniqueIDs: true
  tokenTTL: 1h
  tokenMaxTTL: 8h
  tokenExplicitMaxTTL: 24h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - app-read
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthRole
metadata:
  name: aws-ec2
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: aws
  name: ec2
  authType: ec2
  boundAMIIDs:
    - ami-0123456789abcdef0
  boundAccountIDs:
    - "123456789012"
  roleTag: VaultRole
  allowInstanceMigration: false
  disallowReauthentication: true
  tokenPolicies:
    - app-read
examples-generated/auth/awsauthrole.yaml
# AWSAuthRole (auth.openbaoconfig.io/v1alpha1)
# AWSAuthRole manages a role of an OpenBao AWS auth method at auth/<mountPath>/role/<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/auth/#awsauthrole
# Curated example: examples/auth/awsauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthRole
metadata:
  name: example
  namespace: openbao-config
spec:
  authType: iam
  boundAMIIDs:
  - example
  boundAccountIDs:
  - example
  boundEC2InstanceIDs:
  - example
  boundIAMInstanceProfileARNs:
  - example
  boundIAMPrincipalARNs:
  - example
  boundIAMRoleARNs:
  - example
  boundRegions:
  - example
  boundSubnetIDs:
  - example
  boundVPCIDs:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  inferredAWSRegion: example
  inferredEntityType: ec2_instance
  managementPolicy: Manage
  mountPath: aws
  name: example
  namespace: example
  policyRefs:
  - name: example
  resolveAWSUniqueIDs: true
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default

AWSAuthSTSRole

AWSAuthSTSRole manages the STS role an OpenBao AWS auth method assumes for one AWS account, at auth/<mountPath>/config/sts/<accountID>.

API reference

examples/auth/awsauthstsrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthSTSRole
metadata:
  name: aws-sts-123456789012
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: aws
  accountID: "123456789012"
  stsRole: arn:aws:iam::123456789012:role/openbao-login-verifier
  externalID: openbao-config
examples-generated/auth/awsauthstsrole.yaml
# AWSAuthSTSRole (auth.openbaoconfig.io/v1alpha1)
# AWSAuthSTSRole manages the STS role an OpenBao AWS auth method assumes for one AWS account, at
# auth/<mountPath>/config/sts/<accountID>.
#
# 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: accountID, connectionRef, stsRole.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#awsauthstsrole
# Curated example: examples/auth/awsauthstsrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthSTSRole
metadata:
  name: example
  namespace: openbao-config
spec:
  accountID: "000000000000"
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  externalID: example
  managementPolicy: Manage
  mountPath: aws
  namespace: example
  stsRole: 'arn:'

AWSAuthTidyConfig

AWSAuthTidyConfig manages the periodic tidy settings of an OpenBao AWS auth method, at auth/<mountPath>/config/tidy/identity-accesslist and auth/<mountPath>/config/tidy/roletag-denylist.

API reference

examples/auth/awsauthtidyconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthTidyConfig
metadata:
  name: aws-tidy
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: aws
  identityAccessList:
    safetyBuffer: 72h
    disablePeriodicTidy: false
  roleTagDenyList:
    safetyBuffer: 72h
    disablePeriodicTidy: false
examples-generated/auth/awsauthtidyconfig.yaml
# AWSAuthTidyConfig (auth.openbaoconfig.io/v1alpha1)
# AWSAuthTidyConfig manages the periodic tidy settings of an OpenBao AWS auth method, at
# auth/<mountPath>/config/tidy/identity-accesslist and auth/<mountPath>/config/tidy/roletag-denylist.
#
# 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/auth/#awsauthtidyconfig
# Curated example: examples/auth/awsauthtidyconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthTidyConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  identityAccessList:
    disablePeriodicTidy: true
    safetyBuffer: 1h
  managementPolicy: Manage
  mountPath: aws
  namespace: example
  roleTagDenyList:
    disablePeriodicTidy: true
    safetyBuffer: 1h

AppRole

An AppRole role for a CI deployer outside Kubernetes: a fixed role ID, secret IDs bound to a CIDR and valid for a day, and short-lived tokens with the ci-deployer policy.

API reference

examples/auth/approle.yaml
# An AppRole role for a CI deployer outside Kubernetes: a fixed role ID, secret IDs bound to a CIDR and valid for a
# day, and short-lived tokens with the ci-deployer policy.
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AppRole
metadata:
  name: ci-deployer
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: approle
  name: ci-deployer
  roleID: ci-deployer-role-id
  bindSecretID: true
  secretIDBoundCIDRs:
    - 10.42.0.0/16
  secretIDNumUses: 0
  secretIDTTL: 24h
  localSecretIDs: false
  tokenTTL: 20m
  tokenMaxTTL: 1h
  tokenExplicitMaxTTL: 2h
  tokenPeriod: 0s
  tokenPolicies:
    - ci-deployer
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.42.0.0/16
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/approle.yaml
# AppRole (auth.openbaoconfig.io/v1alpha1)
# AppRole manages a role of an OpenBao AppRole auth method at auth/<mountPath>/role/<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/auth/#approle
# Curated example: examples/auth/approle.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AppRole
metadata:
  name: example
  namespace: openbao-config
spec:
  bindSecretID: true
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  localSecretIDs: true
  managementPolicy: Manage
  mountPath: approle
  name: example
  namespace: example
  policyRefs:
  - name: example
  roleID: example
  secretIDBoundCIDRs:
  - 10.0.0.0/8
  secretIDNumUses: 1
  secretIDTTL: 1h
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default

AppRoleSecretID

AppRoleSecretID generates a secret ID for an OpenBao AppRole role at auth/<mountPath>/role/<role>/secret-id and writes it, with the role ID, to a Kubernetes Secret.

API reference

examples/auth/approlesecretid.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AppRoleSecretID
metadata:
  name: ci-deployer-login
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  roleRef:
    name: ci-deployer
  metadata:
    team: platform
    pipeline: deploy
  cidrList:
    - 10.42.0.0/16
  tokenBoundCIDRs:
    - 10.42.0.0/16
  ttl: 12h
  numUses: 0
  writeSecretRef:
    name: ci-deployer-approle
  rotation:
    enabled: true
    renewBefore: 33%
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AppRoleSecretID
metadata:
  name: ci-deployer-login-by-name
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: approle
  roleName: ci-deployer
  ttl: 6h
  numUses: 10
  writeSecretRef:
    name: ci-deployer-approle-by-name
  rotation:
    enabled: true
    renewBefore: 2h
examples-generated/auth/approlesecretid.yaml
# AppRoleSecretID (auth.openbaoconfig.io/v1alpha1)
# AppRoleSecretID generates a secret ID for an OpenBao AppRole role at auth/<mountPath>/role/<role>/secret-id and
# writes it, with the role ID, to a Kubernetes Secret.
#
# 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, writeSecretRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#approlesecretid
# Curated example: examples/auth/approlesecretid.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AppRoleSecretID
metadata:
  name: example
  namespace: openbao-config
spec:
  cidrList:
  - 10.0.0.0/8
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  metadata:
    example: example
  mountPath: example
  namespace: example
  numUses: 1
  roleName: example
  rotation:
    enabled: true
    renewBefore: 1h
  tokenBoundCIDRs:
  - 10.0.0.0/8
  ttl: 1h
  writeSecretRef:
    name: approlesecretid-write-secret-ref

AzureAuthConfig

AzureAuthConfig manages the configuration of an OpenBao Azure auth method at auth/<mountPath>/config.

API reference

examples/auth/azureauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AzureAuthConfig
metadata:
  name: azure
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: azure
  tenantID: 00000000-0000-0000-0000-000000000001
  resource: https://management.azure.com/
  environment: AzurePublicCloud
  clientID: 00000000-0000-0000-0000-000000000002
  clientSecretSecretRef:
    name: azure-auth-credentials
    key: client-secret
  maxRetries: 3
  retryDelay: 4s
  maxRetryDelay: 60s
---
apiVersion: v1
kind: Secret
metadata:
  name: azure-auth-credentials
  namespace: openbao-config
type: Opaque
stringData:
  client-secret: fake-client-secret-not-real
examples-generated/auth/azureauthconfig.yaml
# AzureAuthConfig (auth.openbaoconfig.io/v1alpha1)
# AzureAuthConfig manages the configuration of an OpenBao Azure auth method at auth/<mountPath>/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: connectionRef, resource,
# tenantID.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#azureauthconfig
# Curated example: examples/auth/azureauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AzureAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  clientID: example
  clientSecretSecretRef:
    key: value
    name: azureauthconfig-client-secret-secret-ref
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  environment: AzurePublicCloud
  managementPolicy: Manage
  maxRetries: 1
  maxRetryDelay: 1h
  mountPath: azure
  namespace: example
  resource: example
  retryDelay: 1h
  tenantID: example
---
apiVersion: v1
kind: Secret
metadata:
  name: azureauthconfig-client-secret-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

AzureAuthRole

AzureAuthRole manages a role of an OpenBao Azure auth method at auth/<mountPath>/role/<name>.

API reference

examples/auth/azureauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AzureAuthRole
metadata:
  name: azure-vm
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: azure
  name: vm
  boundServicePrincipalIDs:
    - 00000000-0000-0000-0000-000000000003
  boundGroupIDs:
    - 00000000-0000-0000-0000-000000000004
  boundLocations:
    - westeurope
  boundSubscriptionIDs:
    - 00000000-0000-0000-0000-000000000005
  boundResourceGroups:
    - rg-openbao-config
  boundScaleSets:
    - vmss-openbao-config
  tokenTTL: 1h
  tokenMaxTTL: 8h
  tokenExplicitMaxTTL: 24h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - app-read
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/azureauthrole.yaml
# AzureAuthRole (auth.openbaoconfig.io/v1alpha1)
# AzureAuthRole manages a role of an OpenBao Azure auth method at auth/<mountPath>/role/<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/auth/#azureauthrole
# Curated example: examples/auth/azureauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AzureAuthRole
metadata:
  name: example
  namespace: openbao-config
spec:
  boundGroupIDs:
  - example
  boundLocations:
  - example
  boundResourceGroups:
  - example
  boundScaleSets:
  - example
  boundServicePrincipalIDs:
  - example
  boundSubscriptionIDs:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: azure
  name: example
  namespace: example
  policyRefs:
  - name: example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default

CFAuthConfig

CFAuthConfig manages the configuration of an OpenBao Cloud Foundry auth method at auth/<mountPath>/config.

API reference

examples/auth/cfauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CFAuthConfig
metadata:
  name: cf
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: cf
  identityCACertificates:
    - |
      -----BEGIN CERTIFICATE-----
      MIIBfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfake
      -----END CERTIFICATE-----
  cfAPIAddr: https://api.cf.example.com
  cfUsername: openbao
  cfPasswordSecretRef:
    name: cf-auth-credentials
    key: password
  cfAPITrustedCertificates:
    - |
      -----BEGIN CERTIFICATE-----
      MIIBfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfake
      -----END CERTIFICATE-----
  cfAPIMutualTLSCertificate: |
    -----BEGIN CERTIFICATE-----
    MIIBfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfakeFAKEfake
    -----END CERTIFICATE-----
  cfAPIMutualTLSKeySecretRef:
    name: cf-auth-credentials
    key: mtls-key
  loginMaxSecondsNotBefore: 300
  loginMaxSecondsNotAfter: 60
---
apiVersion: v1
kind: Secret
metadata:
  name: cf-auth-credentials
  namespace: openbao-config
type: Opaque
stringData:
  password: fake-password-not-real
  mtls-key: fake-mtls-private-key-not-real
examples-generated/auth/cfauthconfig.yaml
# CFAuthConfig (auth.openbaoconfig.io/v1alpha1)
# CFAuthConfig manages the configuration of an OpenBao Cloud Foundry auth method at auth/<mountPath>/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: cfAPIAddr, connectionRef,
# identityCACertificates.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#cfauthconfig
# Curated example: examples/auth/cfauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CFAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  cfAPIAddr: https://openbao.example.com:8200
  cfAPIMutualTLSCertificate: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  cfAPIMutualTLSKeySecretRef:
    key: value
    name: cfauthconfig-cf-api-mutual-tls-key-secret-ref
  cfAPITrustedCertificates:
  - |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  cfPasswordSecretRef:
    key: value
    name: cfauthconfig-cf-password-secret-ref
  cfUsername: example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  identityCACertificates:
  - |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  loginMaxSecondsNotAfter: 1
  loginMaxSecondsNotBefore: 1
  managementPolicy: Manage
  mountPath: cf
  namespace: example
---
apiVersion: v1
kind: Secret
metadata:
  name: cfauthconfig-cf-api-mutual-tls-key-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
  name: cfauthconfig-cf-password-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

CFAuthRole

CFAuthRole manages a role of an OpenBao Cloud Foundry auth method at auth/<mountPath>/roles/<name>.

API reference

examples/auth/cfauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CFAuthRole
metadata:
  name: cf-app
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: cf
  name: app
  boundApplicationIDs:
    - 00000000-0000-0000-0000-00000000000a
  boundSpaceIDs:
    - 00000000-0000-0000-0000-00000000000b
  boundOrganizationIDs:
    - 00000000-0000-0000-0000-00000000000c
  boundInstanceIDs:
    - 00000000-0000-0000-0000-00000000000d
  disableIPMatching: false
  tokenTTL: 1h
  tokenMaxTTL: 8h
  tokenExplicitMaxTTL: 24h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - app-read
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/cfauthrole.yaml
# CFAuthRole (auth.openbaoconfig.io/v1alpha1)
# CFAuthRole manages a role of an OpenBao Cloud Foundry auth method at auth/<mountPath>/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: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#cfauthrole
# Curated example: examples/auth/cfauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CFAuthRole
metadata:
  name: example
  namespace: openbao-config
spec:
  boundApplicationIDs:
  - example
  boundInstanceIDs:
  - example
  boundOrganizationIDs:
  - example
  boundSpaceIDs:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  disableIPMatching: true
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: cf
  name: example
  namespace: example
  policyRefs:
  - name: example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default

CertAuthCRL

CertAuthCRL installs a certificate revocation list on a TLS certificate auth method at auth/<mountPath>/crls/<name>, either as a fetched URL or as embedded PEM data.

API reference

examples/auth/certauthcrl.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CertAuthCRL
metadata:
  name: example-ca
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  crl: |
    -----BEGIN X509 CRL-----
    MIG3MGACAQEwCgYIKoZIzj0EAwIwABcNMjYxMTE2MTAzODQ2WhcNMjYxMTE3MTAz
    ODQ2WqAvMC0wHwYDVR0jBBgwFoAU7xwkWwOR9+o7qHZ58wPaWG8ARyMwCgYDVR0U
    BAMCAQEwCgYIKoZIzj0EAwIDRwAwRAIgFWHBRwqJ8at32iHshO0zV4jtilTY598l
    UC40LlYDsuoCIA70OMlKXSLm8DnTkuUcmQwDbc1cr5twjFkUn8MSfzlp
    -----END X509 CRL-----
examples-generated/auth/certauthcrl.yaml
# CertAuthCRL (auth.openbaoconfig.io/v1alpha1)
# CertAuthCRL installs a certificate revocation list on a TLS certificate auth method at auth/<mountPath>/crls/<name>,
# either as a fetched URL or as embedded PEM data.
#
# 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/auth/#certauthcrl
# Curated example: examples/auth/certauthcrl.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CertAuthCRL
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  crl: example
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: cert
  name: example
  namespace: example

CertAuthConfig

CertAuthConfig manages the mount-wide settings of an OpenBao TLS certificate auth method at auth/<mountPath>/config.

API reference

examples/auth/certauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CertAuthConfig
metadata:
  name: cert
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: cert
  disableBinding: false
  enableIdentityAliasMetadata: true
  ocspCacheSize: 200
examples-generated/auth/certauthconfig.yaml
# CertAuthConfig (auth.openbaoconfig.io/v1alpha1)
# CertAuthConfig manages the mount-wide settings of an OpenBao TLS certificate auth method at auth/<mountPath>/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.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#certauthconfig
# Curated example: examples/auth/certauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CertAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Adopt
  deletionPolicy: Orphan
  disableBinding: true
  driftDetection: Enabled
  driftInterval: 1h
  enableIdentityAliasMetadata: true
  managementPolicy: Manage
  mountPath: cert
  namespace: example
  ocspCacheSize: 2

CertAuthRole

CertAuthRole manages a trusted certificate role of an OpenBao TLS certificate auth method at auth/<mountPath>/certs/<name>.

API reference

examples/auth/certauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CertAuthRole
metadata:
  name: web-clients
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: cert
  name: web-clients
  certificate: |
    -----BEGIN CERTIFICATE-----
    MIIBYTCCAQigAwIBAgIUDMw3azJKyUnZ9ymx9nkMtOKG9E4wCgYIKoZIzj0EAwIw
    FzEVMBMGA1UEAwwMb2Jjby10ZXN0LWNhMB4XDTI2MTExMzIyMjQzMVoXDTM2MTEx
    MDIyMjQzMVowFzEVMBMGA1UEAwwMb2Jjby10ZXN0LWNhMFkwEwYHKoZIzj0CAQYI
    KoZIzj0DAQcDQgAEFoZh98uaZo4/3v5cSywC0uH8ZiSzf95fG9lCWe6uidPOb9Dy
    C265JytUU1VV9tZ247yA5L72vzWiOTDa/9K3z6MyMDAwHQYDVR0OBBYEFAiOukMR
    doR39VvDsVQ++aFecP+GMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDRwAw
    RAIgBLc18g1ypCtJR5OaZI02SIu41XxJdIhT7jGPEsF57AkCIC92H/jJrXlX07vC
    ymDvgfvtQ0UWHcdGzHZe+eCO1ZqD
    -----END CERTIFICATE-----
  displayName: web-clients
  allowedCommonNames:
    - "*.clients.example.com"
  allowedDNSSANs:
    - "*.clients.example.com"
  allowedEmailSANs:
    - ops@example.com
  allowedURISANs:
    - spiffe://example.com/clients/*
  allowedOrganizationalUnits:
    - platform
  requiredExtensions:
    - "2.1.1.1:client"
  allowedMetadataExtensions:
    - 2.1.1.2
  ocspEnabled: false
  ocspCACertificates: |
    -----BEGIN CERTIFICATE-----
    MIIBYTCCAQigAwIBAgIUDMw3azJKyUnZ9ymx9nkMtOKG9E4wCgYIKoZIzj0EAwIw
    FzEVMBMGA1UEAwwMb2Jjby10ZXN0LWNhMB4XDTI2MTExMzIyMjQzMVoXDTM2MTEx
    MDIyMjQzMVowFzEVMBMGA1UEAwwMb2Jjby10ZXN0LWNhMFkwEwYHKoZIzj0CAQYI
    KoZIzj0DAQcDQgAEFoZh98uaZo4/3v5cSywC0uH8ZiSzf95fG9lCWe6uidPOb9Dy
    C265JytUU1VV9tZ247yA5L72vzWiOTDa/9K3z6MyMDAwHQYDVR0OBBYEFAiOukMR
    doR39VvDsVQ++aFecP+GMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDRwAw
    RAIgBLc18g1ypCtJR5OaZI02SIu41XxJdIhT7jGPEsF57AkCIC92H/jJrXlX07vC
    ymDvgfvtQ0UWHcdGzHZe+eCO1ZqD
    -----END CERTIFICATE-----
  ocspServersOverride:
    - http://ocsp.example.com
  ocspFailOpen: false
  ocspQueryAllServers: false
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 0s
  tokenPolicies:
    - web-client
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.42.0.0/16
  tokenNumUses: 0
  tokenType: default
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/certauthrole.yaml
# CertAuthRole (auth.openbaoconfig.io/v1alpha1)
# CertAuthRole manages a trusted certificate role of an OpenBao TLS certificate auth method at
# auth/<mountPath>/certs/<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.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#certauthrole
# Curated example: examples/auth/certauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: CertAuthRole
metadata:
  name: example
  namespace: openbao-config
spec:
  allowedCommonNames:
  - example
  allowedDNSSANs:
  - example
  allowedEmailSANs:
  - user@example.com
  allowedMetadataExtensions:
  - example
  allowedOrganizationalUnits:
  - example
  allowedURISANs:
  - https://openbao.example.com:8200
  certificate: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  displayName: example
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: cert
  name: example
  namespace: example
  ocspCACertificates: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  ocspEnabled: true
  ocspFailOpen: true
  ocspQueryAllServers: true
  ocspServersOverride:
  - example
  policyRefs:
  - name: example
  requiredExtensions:
  - example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default

GCPAuthConfig

GCPAuthConfig manages the configuration of an OpenBao GCP auth method at auth/<mountPath>/config.

API reference

examples/auth/gcpauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GCPAuthConfig
metadata:
  name: gcp
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: gcp
  credentialsSecretRef:
    name: gcp-auth-credentials
    key: credentials.json
  iamAlias: unique_id
  iamMetadata:
    - project_id
    - role
  gceAlias: instance_id
  gceMetadata:
    - zone
    - instance_id
  customEndpoint:
    api: https://www.googleapis.com
    iam: https://iam.googleapis.com
    crm: https://cloudresourcemanager.googleapis.com
    compute: https://compute.googleapis.com
---
apiVersion: v1
kind: Secret
metadata:
  name: gcp-auth-credentials
  namespace: openbao-config
type: Opaque
stringData:
  credentials.json: '{"type":"service_account","project_id":"fake-project","private_key":"fake-not-real"}'
examples-generated/auth/gcpauthconfig.yaml
# GCPAuthConfig (auth.openbaoconfig.io/v1alpha1)
# GCPAuthConfig manages the configuration of an OpenBao GCP auth method at auth/<mountPath>/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: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#gcpauthconfig
# Curated example: examples/auth/gcpauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GCPAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  credentialsSecretRef:
    key: value
    name: gcpauthconfig-credentials-secret-ref
  customEndpoint:
    api: example
    compute: example
    crm: example
    iam: example
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  gceAlias: role_id
  gceMetadata:
  - example
  iamAlias: role_id
  iamMetadata:
  - example
  managementPolicy: Manage
  mountPath: gcp
  namespace: example
---
apiVersion: v1
kind: Secret
metadata:
  name: gcpauthconfig-credentials-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

GCPAuthRole

GCPAuthRole manages a role of an OpenBao GCP auth method at auth/<mountPath>/role/<name>.

API reference

examples/auth/gcpauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GCPAuthRole
metadata:
  name: gcp-gce
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: gcp
  name: gce
  type: gce
  boundServiceAccounts:
    - app@fake-project.iam.gserviceaccount.com
  boundProjects:
    - fake-project
  addGroupAliases: true
  boundZones:
    - europe-west3-a
  boundRegions:
    - europe-west3
  boundInstanceGroups:
    - openbao-config-group
  boundLabels:
    env: sandbox
    team: obco
  tokenTTL: 1h
  tokenMaxTTL: 8h
  tokenExplicitMaxTTL: 24h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - app-read
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GCPAuthRole
metadata:
  name: gcp-iam
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: gcp
  name: iam
  type: iam
  boundServiceAccounts:
    - app@fake-project.iam.gserviceaccount.com
  boundProjects:
    - fake-project
  addGroupAliases: false
  maxJWTExp: 15m
  allowGCEInference: true
  tokenPolicies:
    - app-read
examples-generated/auth/gcpauthrole.yaml
# GCPAuthRole (auth.openbaoconfig.io/v1alpha1)
# GCPAuthRole manages a role of an OpenBao GCP auth method at auth/<mountPath>/role/<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, type.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#gcpauthrole
# Curated example: examples/auth/gcpauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GCPAuthRole
metadata:
  name: example
  namespace: openbao-config
spec:
  addGroupAliases: true
  allowGCEInference: true
  boundProjects:
  - example
  boundServiceAccounts:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  maxJWTExp: 1h
  mountPath: gcp
  name: example
  namespace: example
  policyRefs:
  - name: example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default
  type: iam

GitHubAuthConfig

GitHubAuthConfig manages the configuration of an OpenBao GitHub auth method at auth/<mountPath>/config.

API reference

examples/auth/githubauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GitHubAuthConfig
metadata:
  name: github
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: github
  organization: example-org
  organizationID: 1234567
  baseURL: https://github.example.org/api/v3/
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - readers
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/githubauthconfig.yaml
# GitHubAuthConfig (auth.openbaoconfig.io/v1alpha1)
# GitHubAuthConfig manages the configuration of an OpenBao GitHub auth method at auth/<mountPath>/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, organization.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#githubauthconfig
# Curated example: examples/auth/githubauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GitHubAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  baseURL: https://openbao.example.com:8200
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: github
  namespace: example
  organization: example
  organizationID: 1
  policyRefs:
  - name: example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default

GitHubAuthTeam

GitHubAuthTeam manages the policy mapping of a GitHub team in an OpenBao GitHub auth method at auth/<mountPath>/map/teams/<name>.

API reference

examples/auth/githubauthteam.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GitHubAuthTeam
metadata:
  name: platform-team
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: github
  name: platform-team
  policies:
    - platform-admin
    - readers
examples-generated/auth/githubauthteam.yaml
# GitHubAuthTeam (auth.openbaoconfig.io/v1alpha1)
# GitHubAuthTeam manages the policy mapping of a GitHub team in an OpenBao GitHub auth method at
# auth/<mountPath>/map/teams/<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/auth/#githubauthteam
# Curated example: examples/auth/githubauthteam.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GitHubAuthTeam
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: github
  name: example
  namespace: example
  policies:
  - default

GitHubAuthUser

GitHubAuthUser manages the policy mapping of a GitHub user in an OpenBao GitHub auth method at auth/<mountPath>/map/users/<name>.

API reference

examples/auth/githubauthuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GitHubAuthUser
metadata:
  name: octocat
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: github
  name: octocat
  policies:
    - break-glass
examples-generated/auth/githubauthuser.yaml
# GitHubAuthUser (auth.openbaoconfig.io/v1alpha1)
# GitHubAuthUser manages the policy mapping of a GitHub user in an OpenBao GitHub auth method at
# auth/<mountPath>/map/users/<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/auth/#githubauthuser
# Curated example: examples/auth/githubauthuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GitHubAuthUser
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: github
  name: example
  namespace: example
  policies:
  - default

JWTAuthConfig

Configures the oidc mount for browser logins through a Keycloak realm found by OIDC discovery, with the client secret read from a Secret.

API reference

examples/auth/jwtauthconfig.yaml
# Configures the oidc mount for browser logins through a Keycloak realm
# found by OIDC discovery, with the client secret read from a Secret.
# The other resources verify CI job JWTs with a JWKS URL, Kubernetes
# ServiceAccount tokens with a static public key, and Google Workspace
# logins with a provider configuration from a Secret.
apiVersion: v1
kind: Secret
metadata:
  name: oidc-client
type: Opaque
stringData:
  client-secret: fake-oidc-client-secret-not-real
---
apiVersion: v1
kind: Secret
metadata:
  name: gsuite-provider
type: Opaque
stringData:
  config: '{"gsuite_service_account": "{\"type\": \"service_account\", \"private_key\": \"fake-not-a-real-key\"}"}'
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
  name: oidc
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: oidc
  oidcDiscoveryURL: https://keycloak.example.com/realms/platform
  oidcDiscoveryCAPEM: |
    -----BEGIN CERTIFICATE-----
    RkFLRS1DQS1DRVJUSUZJQ0FURS1GT1ItRVhBTVBMRVMtT05MWQ==
    -----END CERTIFICATE-----
  oidcClientID: openbao
  oidcClientSecretSecretRef:
    name: oidc-client
    key: client-secret
  oidcResponseMode: form_post
  oidcResponseTypes:
    - code
    - id_token
  jwtSupportedAlgs:
    - RS256
    - ES256
  boundIssuer: https://keycloak.example.com/realms/platform
  defaultRole: reader
  overrideAllowedServerNames:
    - keycloak.internal.example.com
  namespaceInState: true
  skipJWKSValidation: false
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
  name: jwt-jwks
spec:
  connectionRef:
    name: openbao
  mountPath: jwt-ci
  jwksURL: https://gitlab.example.com/oauth/discovery/keys
  jwksCAPEM: |
    -----BEGIN CERTIFICATE-----
    RkFLRS1DQS1DRVJUSUZJQ0FURS1GT1ItRVhBTVBMRVMtT05MWQ==
    -----END CERTIFICATE-----
  boundIssuer: https://gitlab.example.com
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
  name: jwt
spec:
  connectionRef:
    name: openbao
  mountPath: jwt
  jwtValidationPubkeys:
    - |
      -----BEGIN PUBLIC KEY-----
      RkFLRS1QVUJMSUMtS0VZLUZPUi1FWEFNUExFUy1PTkxZ
      -----END PUBLIC KEY-----
  boundIssuer: https://kubernetes.default.svc.cluster.local
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
  name: gsuite
spec:
  connectionRef:
    name: openbao
  mountPath: gsuite
  oidcDiscoveryURL: https://accounts.google.com
  oidcClientID: fake-client-id.apps.googleusercontent.com
  oidcClientSecretSecretRef:
    name: oidc-client
    key: client-secret
  providerConfig:
    provider: gsuite
    settings:
      admin_impersonate: admin@example.com
      fetch_groups: true
      groups_recurse_max_depth: 5
    secretRef:
      name: gsuite-provider
      key: config
examples-generated/auth/jwtauthconfig.yaml
# JWTAuthConfig (auth.openbaoconfig.io/v1alpha1)
# JWTAuthConfig manages the configuration of an OpenBao JWT/OIDC auth method at auth/<mountPath>/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: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#jwtauthconfig
# Curated example: examples/auth/jwtauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  boundIssuer: https://openbao.example.com:8200
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  defaultRole: example
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  jwksCAPEM: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  jwtSupportedAlgs:
  - example
  managementPolicy: Manage
  mountPath: jwt
  namespace: example
  namespaceInState: true
  oidcClientID: example
  oidcClientSecretSecretRef:
    key: value
    name: jwtauthconfig-oidc-client-secret-secret-ref
  oidcDiscoveryCAPEM: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  oidcDiscoveryURL: https://openbao.example.com:8200
  oidcResponseMode: query
  oidcResponseTypes:
  - code
  overrideAllowedServerNames:
  - example
  providerConfig:
    provider: azure
    secretRef:
      key: value
      name: jwtauthconfig-secret-ref
    settings:
      example:
        key: value
  skipJWKSValidation: true
---
apiVersion: v1
kind: Secret
metadata:
  name: jwtauthconfig-oidc-client-secret-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
  name: jwtauthconfig-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

JWTAuthRole

Lets CI jobs of the protected main branch of platform/app log in on the jwt-ci mount with their job JWT: the subject, audience and claims are bound, and the project path and ref become token metadata.

API reference

examples/auth/jwtauthrole.yaml
# Lets CI jobs of the protected main branch of platform/app log in on the jwt-ci mount with their job JWT: the
# subject, audience and claims are bound, and the project path and ref become token metadata.
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthRole
metadata:
  name: ci-deploy
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: jwt-ci
  name: ci-deploy
  roleType: jwt
  userClaim: sub
  userClaimJSONPointer: false
  boundAudiences:
    - https://openbao.example.com
  boundSubject: project_path:platform/app:ref_type:branch:ref:main
  boundClaimsType: glob
  boundClaims:
    project_path:
      - platform/*
    ref_protected:
      - "true"
  claimMappings:
    project_path: project
    ref: ref
  groupsClaim: groups
  oidcScopes:
    - profile
    - email
  allowedRedirectURIs:
    - https://openbao.example.com/ui/vault/auth/jwt-ci/oidc/callback
  callbackMode: device
  pollInterval: 5
  maxAge: 1h
  expirationLeeway: -1
  notBeforeLeeway: 2m
  clockSkewLeeway: 30
  oauth2Metadata:
    - id_token
  verboseOIDCLogging: false
  tokenPoliciesTemplateClaims: false
  oidcDisableConfirmation: false
  tokenTTL: 10m
  tokenMaxTTL: 1h
  tokenExplicitMaxTTL: 2h
  tokenPeriod: 0s
  tokenPolicies:
    - ci-deploy
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.50.0.0/16
  tokenNumUses: 0
  tokenType: batch
  tokenNoDefaultPolicy: true
  tokenStrictlyBindIP: false
examples-generated/auth/jwtauthrole.yaml
# JWTAuthRole (auth.openbaoconfig.io/v1alpha1)
# JWTAuthRole manages a role of an OpenBao JWT/OIDC auth method at auth/<mountPath>/role/<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, userClaim.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#jwtauthrole
# Curated example: examples/auth/jwtauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthRole
metadata:
  name: example
  namespace: openbao-config
spec:
  allowedRedirectURIs:
  - https://openbao.example.com:8200
  boundAudiences:
  - example
  boundClaims:
    example:
    - example
  boundClaimsType: string
  boundSubject: example
  callbackMode: client
  claimMappings:
    example: example
  clockSkewLeeway: 1
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  expirationLeeway: 1
  groupsClaim: example
  managementPolicy: Manage
  maxAge: 1h
  mountPath: jwt
  name: example
  namespace: example
  notBeforeLeeway: 1
  oauth2Metadata:
  - access_token
  oidcDisableConfirmation: true
  oidcScopes:
  - example
  policyRefs:
  - name: example
  pollInterval: 1
  roleType: jwt
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenPoliciesTemplateClaims: true
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default
  userClaim: example
  userClaimJSONPointer: true
  verboseOIDCLogging: true

JWTCELRole

JWTCELRole manages a CEL role of an OpenBao JWT auth method at auth/<mountPath>/cel/role/<name>.

API reference

examples/auth/jwtcelrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTCELRole
metadata:
  name: ci-cel
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: jwt-ci
  name: ci-cel
  celProgram:
    variables:
      - name: project
        expression: claims.project_path
      - name: protected
        expression: claims.ref_protected == "true"
    expression: 'project.startsWith("platform/") && protected'
  message: only protected refs of platform projects may log in
  boundAudiences:
    - https://openbao.example.com
  expirationLeeway: 150
  notBeforeLeeway: 2m30s
  clockSkewLeeway: -1
examples-generated/auth/jwtcelrole.yaml
# JWTCELRole (auth.openbaoconfig.io/v1alpha1)
# JWTCELRole manages a CEL role of an OpenBao JWT auth method at auth/<mountPath>/cel/role/<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/auth/#jwtcelrole
# Curated example: examples/auth/jwtcelrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTCELRole
metadata:
  name: example
  namespace: openbao-config
spec:
  boundAudiences:
  - example
  celProgram:
    expression: example
    variables:
    - expression: example
      name: example
  clockSkewLeeway: 1
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  expirationLeeway: 1
  managementPolicy: Manage
  message: example
  mountPath: jwt
  name: example
  namespace: example
  notBeforeLeeway: 1

KerberosAuthConfig

KerberosAuthConfig manages the configuration of an OpenBao Kerberos auth method at auth/<mountPath>/config.

API reference

examples/auth/kerberosauthconfig.yaml
apiVersion: v1
kind: Secret
metadata:
  name: kerberos-keytab
type: Opaque
stringData:
  keytab: fake-keytab-bytes-replace-with-kubectl-create-secret-from-file
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KerberosAuthConfig
metadata:
  name: kerberos
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: kerberos
  serviceAccount: openbao_svc
  keytabSecretRef:
    name: kerberos-keytab
    key: keytab
  removeInstanceName: true
  addGroupAliases: true
examples-generated/auth/kerberosauthconfig.yaml
# KerberosAuthConfig (auth.openbaoconfig.io/v1alpha1)
# KerberosAuthConfig manages the configuration of an OpenBao Kerberos auth method at auth/<mountPath>/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: connectionRef,
# keytabSecretRef, serviceAccount.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#kerberosauthconfig
# Curated example: examples/auth/kerberosauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KerberosAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  addGroupAliases: true
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  keytabSecretRef:
    key: value
    name: kerberosauthconfig-keytab-secret-ref
  managementPolicy: Manage
  mountPath: kerberos
  namespace: example
  removeInstanceName: true
  serviceAccount: example
---
apiVersion: v1
kind: Secret
metadata:
  name: kerberosauthconfig-keytab-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

KerberosAuthGroup

KerberosAuthGroup manages an LDAP group mapping of an OpenBao Kerberos auth method at auth/<mountPath>/groups/<name>.

API reference

examples/auth/kerberosauthgroup.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KerberosAuthGroup
metadata:
  name: engineering
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: kerberos
  name: engineering
  policies:
    - engineering
    - readers
examples-generated/auth/kerberosauthgroup.yaml
# KerberosAuthGroup (auth.openbaoconfig.io/v1alpha1)
# KerberosAuthGroup manages an LDAP group mapping of an OpenBao Kerberos auth method at
# auth/<mountPath>/groups/<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/auth/#kerberosauthgroup
# Curated example: examples/auth/kerberosauthgroup.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KerberosAuthGroup
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: kerberos
  name: example
  namespace: example
  policies:
  - default

KerberosAuthLDAPConfig

KerberosAuthLDAPConfig manages the LDAP configuration of an OpenBao Kerberos auth method at auth/<mountPath>/config/ldap.

API reference

examples/auth/kerberosauthldapconfig.yaml
apiVersion: v1
kind: Secret
metadata:
  name: kerberos-ldap-bind
type: Opaque
stringData:
  password: fake-bind-password
  tls.key: fake-ldap-client-key-not-pem
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KerberosAuthLDAPConfig
metadata:
  name: kerberos-ldap
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: kerberos
  url: ldaps://ldap1.example.org,ldaps://ldap2.example.org
  bindDN: cn=openbao,ou=services,dc=example,dc=org
  bindPassSecretRef:
    name: kerberos-ldap-bind
    key: password
  userDN: ou=people,dc=example,dc=org
  userAttr: uid
  userFilter: '(&(objectClass=inetOrgPerson)({{.UserAttr}}={{.Username}}))'
  upnDomain: example.org
  discoverDN: false
  denyNullBind: true
  usernameAsAlias: true
  groupDN: ou=groups,dc=example,dc=org
  groupFilter: '(&(objectClass=groupOfNames)(member={{.UserDN}}))'
  groupAttr: cn
  useTokenGroups: false
  anonymousGroupSearch: false
  caseSensitiveNames: false
  certificate: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1sZGFwLWNh
    -----END CERTIFICATE-----
  clientTLSCert: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1sZGFwLWNsaWVudC1jZXJ0
    -----END CERTIFICATE-----
  clientTLSKeySecretRef:
    name: kerberos-ldap-bind
    key: tls.key
  startTLS: false
  insecureTLS: false
  tlsMinVersion: tls12
  tlsMaxVersion: tls13
  requestTimeout: 1m30s
  connectionTimeout: 30s
  dereferenceAliases: never
  maxPageSize: 500
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - readers
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/kerberosauthldapconfig.yaml
# KerberosAuthLDAPConfig (auth.openbaoconfig.io/v1alpha1)
# KerberosAuthLDAPConfig manages the LDAP configuration of an OpenBao Kerberos auth method at
# auth/<mountPath>/config/ldap.
#
# 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, url.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#kerberosauthldapconfig
# Curated example: examples/auth/kerberosauthldapconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KerberosAuthLDAPConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  anonymousGroupSearch: true
  bindDN: cn=example,dc=example,dc=com
  bindPassSecretRef:
    key: value
    name: kerberosauthldapconfig-bind-pass-secret-ref
  caseSensitiveNames: true
  certificate: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  clientTLSCert: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  clientTLSKeySecretRef:
    key: value
    name: kerberosauthldapconfig-client-tls-key-secret-ref
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  connectionTimeout: 1h
  creationPolicy: Create
  deletionPolicy: Orphan
  denyNullBind: true
  dereferenceAliases: never
  discoverDN: true
  driftDetection: Enabled
  driftInterval: 1h
  groupAttr: example
  groupDN: cn=example,dc=example,dc=com
  groupFilter: example
  insecureTLS: true
  managementPolicy: Manage
  maxPageSize: 1
  mountPath: kerberos
  namespace: example
  policyRefs:
  - name: example
  requestTimeout: 1h
  startTLS: true
  tlsMaxVersion: tls10
  tlsMinVersion: tls10
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default
  upnDomain: example
  url: https://openbao.example.com:8200
  useTokenGroups: true
  userAttr: example
  userDN: cn=example,dc=example,dc=com
  userFilter: example
  usernameAsAlias: true
---
apiVersion: v1
kind: Secret
metadata:
  name: kerberosauthldapconfig-bind-pass-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
  name: kerberosauthldapconfig-client-tls-key-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

KubernetesAuthConfig

Points the kubernetes auth mount at the cluster's API server with its CA certificate, and reads the token reviewer JWT from a Secret.

API reference

examples/auth/kubernetesauthconfig.yaml
# Points the kubernetes auth mount at the cluster's API server with its CA certificate, and reads the token reviewer
# JWT from a Secret.
apiVersion: v1
kind: Secret
metadata:
  name: kubernetes-auth-reviewer
type: Opaque
stringData:
  token: fake.token-reviewer.jwt-not-a-real-token
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KubernetesAuthConfig
metadata:
  name: kubernetes
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: kubernetes
  kubernetesHost: https://kubernetes.default.svc:443
  kubernetesCACert: |
    -----BEGIN CERTIFICATE-----
    RkFLRS1DQS1DRVJUSUZJQ0FURS1GT1ItRVhBTVBMRVMtT05MWQ==
    -----END CERTIFICATE-----
  tokenReviewerJWTSecretRef:
    name: kubernetes-auth-reviewer
    key: token
  pemKeys:
    - |
      -----BEGIN PUBLIC KEY-----
      RkFLRS1QVUJMSUMtS0VZLUZPUi1FWEFNUExFUy1PTkxZ
      -----END PUBLIC KEY-----
  disableLocalCAJWT: true
examples-generated/auth/kubernetesauthconfig.yaml
# KubernetesAuthConfig (auth.openbaoconfig.io/v1alpha1)
# KubernetesAuthConfig manages the configuration of an OpenBao Kubernetes auth method at auth/<mountPath>/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: connectionRef,
# kubernetesHost.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#kubernetesauthconfig
# Curated example: examples/auth/kubernetesauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KubernetesAuthConfig
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: kubernetes
  namespace: example
  pemKeys:
  - |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  tokenReviewerJWTSecretRef:
    key: value
    name: kubernetesauthconfig-token-reviewer-jwt-secret-ref
---
apiVersion: v1
kind: Secret
metadata:
  name: kubernetesauthconfig-token-reviewer-jwt-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

KubernetesAuthRole

Lets pods of ServiceAccount app or app-worker in namespace team-a (or in a namespace selected by labels) log in with the openbao audience and get the app-reader policy plus the policy of a Policy resource.

API reference

examples/auth/kubernetesauthrole.yaml
# Lets pods of ServiceAccount app or app-worker in namespace team-a (or in a namespace selected by labels) log in
# with the openbao audience and get the app-reader policy plus the policy of a Policy resource.
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KubernetesAuthRole
metadata:
  name: app-reader
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: kubernetes
  name: app-reader
  boundServiceAccountNames:
    - app
    - app-worker
  boundServiceAccountNamespaces:
    - team-a
  boundServiceAccountNamespaceSelector:
    matchLabels:
      tenant: team-a
      environment: dev
  audience: openbao
  aliasNameSource: serviceaccount_name
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 30m
  tokenPolicies:
    - app-reader
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.42.0.0/16
    - 10.43.0.10
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/kubernetesauthrole.yaml
# KubernetesAuthRole (auth.openbaoconfig.io/v1alpha1)
# KubernetesAuthRole manages a role of an OpenBao Kubernetes auth method at auth/<mountPath>/role/<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: boundServiceAccountNames, connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#kubernetesauthrole
# Curated example: examples/auth/kubernetesauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: KubernetesAuthRole
metadata:
  name: example
  namespace: openbao-config
spec:
  aliasNameSource: serviceaccount_uid
  audience: example
  boundServiceAccountNames:
  - example
  boundServiceAccountNamespaceSelector:
    matchLabels:
      example: example
  boundServiceAccountNamespaces:
  - example
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: kubernetes
  name: example
  namespace: example
  policyRefs:
  - name: example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default

LDAPAuthConfig

LDAPAuthConfig manages the configuration of an OpenBao LDAP auth method at auth/<mountPath>/config.

API reference

examples/auth/ldapauthconfig.yaml
apiVersion: v1
kind: Secret
metadata:
  name: ldap-auth-bind
type: Opaque
stringData:
  password: fake-bind-password
  tls.key: fake-ldap-client-key-not-pem
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: LDAPAuthConfig
metadata:
  name: ldap
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: ldap
  url: ldaps://ldap1.example.org,ldaps://ldap2.example.org
  bindDN: cn=openbao,ou=services,dc=example,dc=org
  bindPassSecretRef:
    name: ldap-auth-bind
    key: password
  userDN: ou=people,dc=example,dc=org
  userAttr: uid
  userFilter: '(&(objectClass=inetOrgPerson)({{.UserAttr}}={{.Username}}))'
  upnDomain: example.org
  discoverDN: false
  denyNullBind: true
  usernameAsAlias: true
  groupDN: ou=groups,dc=example,dc=org
  groupFilter: '(&(objectClass=groupOfNames)(member={{.UserDN}}))'
  groupAttr: cn
  useTokenGroups: false
  anonymousGroupSearch: false
  caseSensitiveNames: false
  certificate: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1sZGFwLWNh
    -----END CERTIFICATE-----
  clientTLSCert: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1sZGFwLWNsaWVudC1jZXJ0
    -----END CERTIFICATE-----
  clientTLSKeySecretRef:
    name: ldap-auth-bind
    key: tls.key
  startTLS: false
  insecureTLS: false
  tlsMinVersion: tls12
  tlsMaxVersion: tls13
  requestTimeout: 1m30s
  connectionTimeout: 30s
  dereferenceAliases: never
  maxPageSize: 500
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - readers
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/ldapauthconfig.yaml
# LDAPAuthConfig (auth.openbaoconfig.io/v1alpha1)
# LDAPAuthConfig manages the configuration of an OpenBao LDAP auth method at auth/<mountPath>/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: connectionRef, url.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#ldapauthconfig
# Curated example: examples/auth/ldapauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: LDAPAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  anonymousGroupSearch: true
  bindDN: cn=example,dc=example,dc=com
  bindPassSecretRef:
    key: value
    name: ldapauthconfig-bind-pass-secret-ref
  caseSensitiveNames: true
  certificate: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  clientTLSCert: |
    -----BEGIN CERTIFICATE-----
    ZmFrZS1ub3QtYS1jZXJ0aWZpY2F0ZQ==
    -----END CERTIFICATE-----
  clientTLSKeySecretRef:
    key: value
    name: ldapauthconfig-client-tls-key-secret-ref
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  connectionTimeout: 1h
  creationPolicy: Create
  deletionPolicy: Orphan
  denyNullBind: true
  dereferenceAliases: never
  discoverDN: true
  driftDetection: Enabled
  driftInterval: 1h
  groupAttr: example
  groupDN: cn=example,dc=example,dc=com
  groupFilter: example
  insecureTLS: true
  managementPolicy: Manage
  maxPageSize: 1
  mountPath: ldap
  namespace: example
  policyRefs:
  - name: example
  requestTimeout: 1h
  startTLS: true
  tlsMaxVersion: tls10
  tlsMinVersion: tls10
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default
  upnDomain: example
  url: https://openbao.example.com:8200
  useTokenGroups: true
  userAttr: example
  userDN: cn=example,dc=example,dc=com
  userFilter: example
  usernameAsAlias: true
---
apiVersion: v1
kind: Secret
metadata:
  name: ldapauthconfig-bind-pass-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque
---
apiVersion: v1
kind: Secret
metadata:
  name: ldapauthconfig-client-tls-key-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

LDAPAuthGroup

LDAPAuthGroup manages an LDAP group mapping of an OpenBao LDAP auth method at auth/<mountPath>/groups/<name>.

API reference

examples/auth/ldapauthgroup.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: LDAPAuthGroup
metadata:
  name: ops-team
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: ldap
  name: Ops Team
  policies:
    - ops
    - readers
examples-generated/auth/ldapauthgroup.yaml
# LDAPAuthGroup (auth.openbaoconfig.io/v1alpha1)
# LDAPAuthGroup manages an LDAP group mapping of an OpenBao LDAP auth method at auth/<mountPath>/groups/<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/auth/#ldapauthgroup
# Curated example: examples/auth/ldapauthgroup.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: LDAPAuthGroup
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: ldap
  name: example
  namespace: example
  policies:
  - default

LDAPAuthUser

LDAPAuthUser manages an LDAP user entry of an OpenBao LDAP auth method at auth/<mountPath>/users/<name>.

API reference

examples/auth/ldapauthuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: LDAPAuthUser
metadata:
  name: jdoe
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: ldap
  name: jdoe
  groups:
    - Ops Team
    - auditors
  policies:
    - personal-jdoe
examples-generated/auth/ldapauthuser.yaml
# LDAPAuthUser (auth.openbaoconfig.io/v1alpha1)
# LDAPAuthUser manages an LDAP user entry of an OpenBao LDAP auth method at auth/<mountPath>/users/<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/auth/#ldapauthuser
# Curated example: examples/auth/ldapauthuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: LDAPAuthUser
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  groups:
  - example
  managementPolicy: Manage
  mountPath: ldap
  name: example
  namespace: example
  policies:
  - default

OCIAuthConfig

OCIAuthConfig manages the configuration of an OpenBao Oracle Cloud Infrastructure (OCI) auth method at auth/<mountPath>/config.

API reference

examples/auth/ociauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OCIAuthConfig
metadata:
  name: oci
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: oci
  homeTenancyID: ocid1.tenancy.oc1..aaaaaaaafakefakefakefake
examples-generated/auth/ociauthconfig.yaml
# OCIAuthConfig (auth.openbaoconfig.io/v1alpha1)
# OCIAuthConfig manages the configuration of an OpenBao Oracle Cloud Infrastructure (OCI) auth method at
# auth/<mountPath>/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, homeTenancyID.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#ociauthconfig
# Curated example: examples/auth/ociauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OCIAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  homeTenancyID: example
  managementPolicy: Manage
  mountPath: oci
  namespace: example

OCIAuthRole

OCIAuthRole manages a role of an OpenBao Oracle Cloud Infrastructure (OCI) auth method at auth/<mountPath>/role/<name>.

API reference

examples/auth/ociauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OCIAuthRole
metadata:
  name: oci-ops
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: oci
  name: ops
  ocidList:
    - ocid1.group.oc1..aaaaaaaafakefakefakefake
    - ocid1.dynamicgroup.oc1..aaaaaaaafakefakefakefake
  tokenTTL: 1h
  tokenMaxTTL: 8h
  tokenExplicitMaxTTL: 24h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - app-read
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/ociauthrole.yaml
# OCIAuthRole (auth.openbaoconfig.io/v1alpha1)
# OCIAuthRole manages a role of an OpenBao Oracle Cloud Infrastructure (OCI) auth method at
# auth/<mountPath>/role/<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/auth/#ociauthrole
# Curated example: examples/auth/ociauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OCIAuthRole
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: oci
  name: example
  namespace: example
  ocidList:
  - example
  policyRefs:
  - name: example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default

OktaAuthConfig

OktaAuthConfig manages the configuration of an OpenBao Okta auth method at auth/<mountPath>/config.

API reference

examples/auth/oktaauthconfig.yaml
apiVersion: v1
kind: Secret
metadata:
  name: okta-api-token
type: Opaque
stringData:
  token: fake-okta-api-token
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OktaAuthConfig
metadata:
  name: okta
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: okta
  orgName: example
  apiTokenSecretRef:
    name: okta-api-token
    key: token
  baseURL: okta.com
  bypassOktaMFA: false
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - readers
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/oktaauthconfig.yaml
# OktaAuthConfig (auth.openbaoconfig.io/v1alpha1)
# OktaAuthConfig manages the configuration of an OpenBao Okta auth method at auth/<mountPath>/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: connectionRef, orgName.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#oktaauthconfig
# Curated example: examples/auth/oktaauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OktaAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  apiTokenSecretRef:
    key: value
    name: oktaauthconfig-api-token-secret-ref
  baseURL: https://openbao.example.com:8200
  bypassOktaMFA: true
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: okta
  namespace: example
  orgName: example
  policyRefs:
  - name: example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default
---
apiVersion: v1
kind: Secret
metadata:
  name: oktaauthconfig-api-token-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

OktaAuthGroup

OktaAuthGroup manages the policy mapping of an Okta group in an OpenBao Okta auth method at auth/<mountPath>/groups/<name>.

API reference

examples/auth/oktaauthgroup.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OktaAuthGroup
metadata:
  name: okta-admins
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: okta
  name: Admins
  policies:
    - admin
examples-generated/auth/oktaauthgroup.yaml
# OktaAuthGroup (auth.openbaoconfig.io/v1alpha1)
# OktaAuthGroup manages the policy mapping of an Okta group in an OpenBao Okta auth method at
# auth/<mountPath>/groups/<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/auth/#oktaauthgroup
# Curated example: examples/auth/oktaauthgroup.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OktaAuthGroup
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: okta
  name: example
  namespace: example
  policies:
  - default

OktaAuthUser

OktaAuthUser manages an Okta user entry in an OpenBao Okta auth method at auth/<mountPath>/users/<name>.

API reference

examples/auth/oktaauthuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OktaAuthUser
metadata:
  name: jane
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: okta
  name: jane@example.org
  groups:
    - Admins
    - Developers
  policies:
    - personal-jane
examples-generated/auth/oktaauthuser.yaml
# OktaAuthUser (auth.openbaoconfig.io/v1alpha1)
# OktaAuthUser manages an Okta user entry in an OpenBao Okta auth method at auth/<mountPath>/users/<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/auth/#oktaauthuser
# Curated example: examples/auth/oktaauthuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: OktaAuthUser
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  groups:
  - example
  managementPolicy: Manage
  mountPath: okta
  name: example
  namespace: example
  policies:
  - default

RADIUSAuthConfig

RADIUSAuthConfig manages the configuration of an OpenBao RADIUS auth method at auth/<mountPath>/config.

API reference

examples/auth/radiusauthconfig.yaml
apiVersion: v1
kind: Secret
metadata:
  name: radius-shared-secret
type: Opaque
stringData:
  secret: fake-radius-shared-secret
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: RADIUSAuthConfig
metadata:
  name: radius
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: radius
  host: radius.example.org
  port: 1812
  secretSecretRef:
    name: radius-shared-secret
    key: secret
  unregisteredUserPolicies:
    - guest
  dialTimeout: 10s
  readTimeout: 15s
  nasPort: 10
  nasIdentifier: openbao
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - readers
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.0.0.0/8
    - 192.168.10.0/24
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: false
  tokenStrictlyBindIP: false
examples-generated/auth/radiusauthconfig.yaml
# RADIUSAuthConfig (auth.openbaoconfig.io/v1alpha1)
# RADIUSAuthConfig manages the configuration of an OpenBao RADIUS auth method at auth/<mountPath>/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: connectionRef, host,
# secretSecretRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#radiusauthconfig
# Curated example: examples/auth/radiusauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: RADIUSAuthConfig
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  dialTimeout: 1h
  driftDetection: Enabled
  driftInterval: 1h
  host: https://openbao.example.com:8200
  managementPolicy: Manage
  mountPath: radius
  namespace: example
  nasIdentifier: example
  nasPort: 1
  policyRefs:
  - name: example
  port: 1
  readTimeout: 1h
  secretSecretRef:
    key: value
    name: radiusauthconfig-secret-secret-ref
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default
  unregisteredUserPolicies:
  - default
---
apiVersion: v1
kind: Secret
metadata:
  name: radiusauthconfig-secret-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque

RADIUSAuthUser

RADIUSAuthUser manages the policies of a RADIUS user at auth/<mountPath>/users/<name>.

API reference

examples/auth/radiusauthuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: RADIUSAuthUser
metadata:
  name: alice
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: radius
  name: alice
  policies:
    - vpn-users
examples-generated/auth/radiusauthuser.yaml
# RADIUSAuthUser (auth.openbaoconfig.io/v1alpha1)
# RADIUSAuthUser manages the policies of a RADIUS user at auth/<mountPath>/users/<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/auth/#radiusauthuser
# Curated example: examples/auth/radiusauthuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: RADIUSAuthUser
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: radius
  name: example
  namespace: example
  policies:
  - default

TokenRole

TokenRole manages a role of the OpenBao token store at auth/token/roles/<name>.

API reference

examples/auth/tokenrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: TokenRole
metadata:
  name: app-issuer
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  name: app-issuer
  allowedPolicies:
    - app-reader
    - app-writer
  disallowedPolicies:
    - admin
  allowedPoliciesGlob:
    - app-*
  disallowedPoliciesGlob:
    - root-*
  allowedEntityAliases:
    - app-*
  orphan: false
  renewable: true
  pathSuffix: app-v1
  tokenExplicitMaxTTL: 24h
  tokenPeriod: 1h
  tokenBoundCIDRs:
    - 10.42.0.0/16
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: true
examples-generated/auth/tokenrole.yaml
# TokenRole (auth.openbaoconfig.io/v1alpha1)
# TokenRole manages a role of the OpenBao token store at auth/token/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: connectionRef.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#tokenrole
# Curated example: examples/auth/tokenrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: TokenRole
metadata:
  name: example
  namespace: openbao-config
spec:
  allowedEntityAliases:
  - example
  allowedPolicies:
  - default
  allowedPoliciesGlob:
  - default
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  disallowedPolicies:
  - default
  disallowedPoliciesGlob:
  - default
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  name: example
  namespace: example
  orphan: true
  pathSuffix: example
  renewable: true
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenType: default

UserpassUser

A break-glass user whose password is read from a Secret, with short tokens bound to a CIDR, plus an auditor user.

API reference

examples/auth/userpassuser.yaml
# A break-glass user whose password is read from a Secret, with short tokens bound to a CIDR, plus an auditor user.
apiVersion: v1
kind: Secret
metadata:
  name: breakglass-login
type: Opaque
stringData:
  password: not-a-real-password-change-me
  bcrypt: $2a$10$fakefakefakefakefakefuDummyHashValueForExamplesOnly000
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: UserpassUser
metadata:
  name: breakglass
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: userpass
  name: breakglass
  passwordSecretRef:
    name: breakglass-login
    key: password
  tokenTTL: 15m
  tokenMaxTTL: 1h
  tokenExplicitMaxTTL: 1h
  tokenPeriod: 0s
  tokenPolicies:
    - breakglass
  policyRefs:
    - name: obco-team-a-reader
  tokenBoundCIDRs:
    - 10.42.0.0/16
  tokenNumUses: 0
  tokenType: service
  tokenNoDefaultPolicy: true
  tokenStrictlyBindIP: false
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: UserpassUser
metadata:
  name: auditor
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  mountPath: userpass
  name: auditor
  passwordHashSecretRef:
    name: breakglass-login
    key: bcrypt
  tokenPolicies:
    - auditor
examples-generated/auth/userpassuser.yaml
# UserpassUser (auth.openbaoconfig.io/v1alpha1)
# UserpassUser manages a user of an OpenBao userpass auth method at auth/<mountPath>/users/<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.
#
# Reference: https://alexandrust88.github.io/openbao-config-operator/reference/api/auth/#userpassuser
# Curated example: examples/auth/userpassuser.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: UserpassUser
metadata:
  name: example
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: Create
  deletionPolicy: Orphan
  driftDetection: Enabled
  driftInterval: 1h
  managementPolicy: Manage
  mountPath: userpass
  name: example
  namespace: example
  passwordSecretRef:
    key: value
    name: userpassuser-password-secret-ref
  policyRefs:
  - name: example
  tokenBoundCIDRs:
  - 10.0.0.0/8
  tokenExplicitMaxTTL: 1h
  tokenMaxTTL: 1h
  tokenNoDefaultPolicy: true
  tokenNumUses: 1
  tokenPeriod: 1h
  tokenPolicies:
  - default
  tokenStrictlyBindIP: true
  tokenTTL: 1h
  tokenType: default
---
apiVersion: v1
kind: Secret
metadata:
  name: userpassuser-password-secret-ref
  namespace: openbao-config
stringData:
  value: fake-value-not-a-secret
type: Opaque