Skip to content

Authentication resources · Kind catalogue · Examples

KubernetesAuthConfig

API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: kubernetesauthconfigs.auth.openbaoconfig.io
Categories: openbao

KubernetesAuthConfig manages the configuration of an OpenBao Kubernetes auth method at auth/<mountPath>/config. Use it to point the mount at a Kubernetes API server so pods can log in with their ServiceAccount token. OpenBao replaces the whole configuration on every write; unset fields go back to OpenBao defaults.

Example:

spec:
  connectionRef:
    name: openbao
  deletionPolicy: Orphan
  mountPath: kubernetes
  kubernetesHost: https://kubernetes.default.svc
  disableLocalCAJWT: false

Example

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

On GitHub: kubernetesauthconfig.yaml, generated sample with every field.

Fields

Defaults below are CRD schema defaults. A blank cell does not imply zero, false or an empty value; see the field description for omission behaviour. Required fields inside an optional object apply only when that object is set.

FieldTypeRequiredDefaultDescriptionValidation
specobjectyesDesired state of the Kubernetes auth method configuration at auth/<mountPath>/config. OpenBao replaces the whole configuration on every write, so fields left unset are reset to their OpenBao defaults. deletionPolicy must be Orphan.
ConstraintsCEL: has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)
CEL: !has(self.deletionPolicy) || self.deletionPolicy == 'Orphan' (deletionPolicy must be Orphan: the auth method configuration cannot be deleted, only replaced)
CEL: !has(self.disableLocalCAJWT) || !self.disableLocalCAJWT || has(self.kubernetesCACert) (kubernetesCACert is required when disableLocalCAJWT is true)
CEL: has(self.__namespace__) == has(oldSelf.__namespace__) && (!has(self.__namespace__) || self.__namespace__ == oldSelf.__namespace__) (namespace is immutable)
CEL: self.connectionRef == oldSelf.connectionRef (connectionRef is immutable)
spec.connectionRefobjectyesConnection used to reach and log in to OpenBao. Immutable.
spec.connectionRef.kindstringno"OpenBaoConnection"Kind of the connection: OpenBaoConnection (in the same Kubernetes namespace as this resource) or ClusterOpenBaoConnection (cluster-scoped; its allowedNamespaces must select this namespace). Default: OpenBaoConnection.
Constraintsone of: OpenBaoConnection, ClusterOpenBaoConnection
spec.connectionRef.namestringyesName of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao
Constraintslength: >=1, <=253
spec.creationPolicystringno"Create"How an object that already exists in OpenBao, and is not yet owned by this resource, is treated. Create (default): create the object; an existing one is refused with reason Conflict. Adopt: take over an existing object and never create one. CreateOrAdopt: create it, or take over an existing one. Settings that always exist in OpenBao (configuration singletons) need Adopt or CreateOrAdopt.
Constraintsone of: Create, Adopt, CreateOrAdopt
spec.deletionPolicystringno"Orphan"What happens in OpenBao when this resource is deleted. Orphan (default): the OpenBao object stays. Delete: the object is removed (a configuration singleton is reset to its defaults); data and key holders (mounts, namespaces, KV data, audit devices, endpoints, transit, PKI, SSH CA and TOTP keys, MFA methods, entities) are removed only while the resource carries the annotation openbaoconfig.io/allow-destructive-delete: "true". Kinds whose OpenBao object cannot be deleted reject Delete.
Constraintsone of: Delete, Orphan
spec.disableLocalCAJWTbooleannoWhen true, OpenBao does not fall back to its pod's local CA certificate and ServiceAccount token; kubernetesCACert is then required. Defaults to false. Maps to `disable_local_ca_jwt`. Example: true
spec.driftDetectionstringno"Enabled"Whether OpenBao is re-read periodically to detect and repair out-of-band changes. Enabled (default): re-read every driftInterval. Disabled: write only when the spec or a referenced Secret changes.
Constraintsone of: Enabled, Disabled
spec.driftIntervalstringnoHow often OpenBao is re-read for drift, as a duration of at least 30s. Default: the operator's interval for the kind (15m for kinds that grant access such as policies, auth mounts and roles, 1h for the rest), with jitter. Example: 30m
Constraintslength: <=32
CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s)
spec.kubernetesCACertstringnoPEM-encoded CA certificate OpenBao uses to verify the Kubernetes API server. When unset, OpenBao uses its pod's local CA certificate; required when disableLocalCAJWT is true. Maps to `kubernetes_ca_cert`. Example: "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
Constraintslength: <=65536
spec.kubernetesHoststringyesKubernetes API server OpenBao calls for TokenReview: a host, a host:port pair or a URL. Required. Maps to `kubernetes_host`. Example: https://kubernetes.default.svc
Constraintslength: >=1, <=2048
spec.managementPolicystringno"Manage"Whether the operator writes to OpenBao. Manage (default): converge OpenBao to the spec, create and delete as the policies say. Observe: only read the object and report drift in the conditions; never write or delete.
Constraintsone of: Manage, Observe
spec.mountPathstringno"kubernetes"Path of the Kubernetes auth method, without the auth/ prefix. Defaults to kubernetes. Immutable. Example: kubernetes/prod-cluster
Constraintspattern: ^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$
length: >=1, <=128
spec.namespacestringnoOpenBao namespace of the object, relative to the connection's base namespace; empty means the connection namespace itself. Segments are separated by "/", without leading or trailing slash. Immutable: it cannot be added, changed or removed after creation. Example: team-a/apps
Constraintspattern: ^[A-Za-z0-9_-][A-Za-z0-9._-]*(/[A-Za-z0-9_-][A-Za-z0-9._-]*)*$
length: <=256
spec.pemKeys[]stringnoPEM-encoded public keys or certificates used to verify ServiceAccount JWT signatures locally instead of through TokenReview. Maps to `pem_keys`. Example: ["-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"]
Constraintsitems: <=32
list type: atomic
each item: length: <=16384
spec.tokenReviewerJWTSecretRefobjectnoSecret key holding the JWT OpenBao uses as bearer token to call the TokenReview API. When unset, OpenBao uses its local ServiceAccount token, or else the JWT of the client logging in. Read from this Secret key; the value is never stored in status. Write-only: only a hash is kept in status.writeOnlyHash and a change of the Secret forces a write. Maps to `token_reviewer_jwt`. Example: {name: openbao-reviewer, key: token}
spec.tokenReviewerJWTSecretRef.keystringyesKey in the Secret's data whose value is used. Example: password
Constraintslength: >=1, <=253
spec.tokenReviewerJWTSecretRef.namestringyesName of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials
Constraintslength: >=1, <=253
statusobjectnoObserved state of the configuration, written by the operator. The token reviewer JWT never appears here.
status.acquiredstringnoHow the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned.
status.conditions[]objectnoCurrent state as conditions: Ready (the OpenBao object matches the spec) and Synced (the last reconcile succeeded), each with a reason such as Available, Drifted, Conflict, ConnectionNotReady or PermissionDenied, and the generation it describes.
Constraintslist type: map (keys: type)
status.conditions[]objectnoCondition contains details for one aspect of the current state of this API Resource.
status.conditions[].lastTransitionTimestring (date-time)yeslastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
status.conditions[].messagestringyesmessage is a human readable message indicating details about the transition. This may be an empty string.
Constraintslength: <=32768
status.conditions[].observedGenerationinteger (int64)noobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
Constraintsvalue: >=0
status.conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
Constraintspattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
length: >=1, <=1024
status.conditions[].statusstringyesstatus of the condition, one of True, False, Unknown.
Constraintsone of: True, False, Unknown
status.conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
Constraintspattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
length: <=316
status.idstringnoIdentifier OpenBao generated for the object (an entity, group or alias ID, or a mount accessor), for kinds that have one; other resources reference it. Example: 6c9f3e0a-1b2c-4d5e-8f90-123456789abc
status.namespacestringnoAbsolute OpenBao namespace the object was written in; empty means the root namespace. If it later differs from the spec, reconciling stops with reason NamespaceChanged. Example: team-a/apps
status.observedGenerationinteger (int64)noThe metadata.generation of this resource that the operator last reconciled.
status.pathstringnoFull OpenBao API path of the object, including its namespace, as last written; deletion uses it even after the spec changed. Example: team-a/sys/policies/acl/app-read
status.rotationNoncestringnoValue of the resource's rotation nonce when one-time inputs, such as a root credential that OpenBao rotates afterwards, were last sent; changing the nonce in the spec sends them again.
status.serverIDstringnoCluster ID of the OpenBao server the object was acquired on. If the connection later reaches another server, reconciling stops with reason ServerChanged and nothing is written or deleted. Example: 80f7de92-c12e-e960-4754-255c32fc6b53
status.writeOnlyHashstringnoKeyed hash (HMAC-SHA256) of the write-only inputs, such as passwords read from Secrets; a change forces a write. It never contains or reveals the values.