Skip to content

Get started

openbao-config-operator manages the configuration of an OpenBao server that already runs: policies, auth methods and roles, secrets engines, identities. You declare each object as a Kubernetes custom resource; the operator writes it to OpenBao, checks it for drift and repairs it. The operator does not install, initialise or unseal OpenBao.

Choose a path

you want to start with you are done when
try the operator on your laptop, with nothing to clean up afterwards Quickstart on kind a policy, a KV mount, a Kubernetes auth role and a generated secret are Ready, a workload reads the secret, and the operator has repaired a change made behind its back
install the operator on a cluster you run Install the manager Deployment is available and kubectl get crd lists the *.openbaoconfig.io CRDs
point the operator at your OpenBao server Connect to OpenBao kubectl get openbaoserver and kubectl get openbaoconnection -A show Ready=True
bring a server that is already configured under the operator Import existing configuration, then Migrate to the operator every imported resource reports Synced=True with reason Observed, then Ready=True in Manage mode

The quickstart is for evaluation only

The quickstart runs OpenBao in dev mode: in-memory storage, plain HTTP and a well-known root token. Use it to learn the operator, never to hold real secrets. For a real cluster, follow Install and Connect to OpenBao.

Before you begin

Every path needs:

  • kubectl and a Kubernetes cluster at version 1.31 or later (the chart's kubeVersion);
  • Helm 3.8 or later, for OCI charts;
  • for any path except the quickstart, an initialised and unsealed OpenBao server that the operator pods can reach, and the rights to enable an auth method and write a policy in it.

How the pieces fit

flowchart LR
  subgraph k8s[Kubernetes]
    server[OpenBaoServer<br/>address, CA, allowed tenants]
    conn[OpenBaoConnection<br/>how to log in]
    res[Policy, SecretsMount,<br/>KubernetesAuthRole, ...]
    op[operator]
  end
  bao[(OpenBao)]
  res -- connectionRef --> conn
  conn -- serverRef --> server
  op -- reads --> res
  op -- logs in and writes --> bao

A platform admin declares each OpenBao server once as an OpenBaoServer. A connection says how the operator logs in to that server, and every resource names its connection. The OpenBao policy behind the connection's identity is the limit of what the resources can change. Concepts explains the model.

Configure your first object

Once the connection is Ready, declare and verify an ACL policy. Then configure Kubernetes authentication to attach that policy to a workload login. The security model explains which identity performs each operation and where tenant isolation is enforced.

Next steps

  • Quickstart on kind


    Ten minutes, one script, a working operator and OpenBao on your laptop.

  • Install


    Helm OCI chart, classic Helm repository or install.yaml, with release verification.

  • Connect to OpenBao


    Declare your server, choose an auth method and check the connection.

  • Guides


    Task-by-task: auth methods, secrets engines, identity, tenants.