Tutorials¶
Four lessons that build a small multi-tenant OpenBao platform on the kind cluster of the quickstart. In each one you act in the role the table names. Each lesson continues from the cluster the one before it left, so follow them in order.
| # | tutorial | you act as | at the end |
|---|---|---|---|
| 1 | Set up the platform | the platform owner, admin of OpenBao and of the cluster | the operator logs in to OpenBao as itself, and configures the root namespace and the platform's own OpenBao namespace |
| 2 | Manage several OpenBao servers | the platform owner | a second OpenBao runs next to the first, and each one holds its own configuration plus one shared policy |
| 3 | Onboard two tenants | the platform admin | tenant-a and tenant-b each have a Kubernetes namespace they administer, an OpenBao namespace and a connection limited to it |
| 4 | Onboard teams as a tenant | the tenant-a admin, with rights in its own namespace only |
the teams devteam and payments each have a child OpenBao namespace that only their workloads can read, and tenant-a cannot reach tenant-b or the root |
Why this operator exists explains what the tenant boundary these lessons build gives you that other tools do not.
Evaluation only
The tutorials use the quickstart's OpenBao dev servers: in-memory storage, plain HTTP and the
root token root. They give the operator a full-admin OpenBao policy so the lessons stay
short. For a real server, see Install,
Connect to OpenBao and
OpenBao policy for the operator.
Before you begin¶
- Finish the quickstart up to step 9, and keep the cluster: do not run its clean-up step.
- Work in the same shell, at the root of the repository clone. Every manifest the tutorials apply
is in
examples/tutorials/, and every command is inhack/docs/tutorial-*.sh.
Run them in one go
hack/docs/tutorials.sh runs the four tutorials in order on the quickstart cluster and fails
at the first step that does not reach its expected state. It then runs the
uninstall steps, which remove the operator. CI runs it
after the quickstart on every change, so the commands on these pages are tested:
Clean up¶
When you are done, delete the kind cluster as in step 10 of the quickstart. Both OpenBao servers and everything they hold go with it.
Application integrations¶
Use these tutorials to connect workloads to operator-managed OpenBao configuration:
- Generate credentials and deliver them with ESO: rotate a password, project selected keys and recover a workload Secret.
- Encrypt application data: encrypt, decrypt, rewrap and migrate ciphertext between transit keys using a workload identity.
- Issue and revoke dynamic database users: verify real logins and tenant-specific permissions with PostgreSQL, MySQL, MariaDB, Cassandra, InfluxDB or Valkey.
These tutorials use the separate local integration lab, rather than the cluster from the four lessons above.