Component

core/security/openbao

An OpenBao secrets-management server. OpenBao stores, generates, and controls access to tokens, passwords, certificates, and other secrets behind an authenticated HTTP API, and encrypts data at rest on a durable data volume — so it renders as a self-hosted, stateful running server, not a managed-cloud resource. Its operational type is therefore `stateful-server`: the deployment runs and owns the OpenBao process backed by a persistent volume. This component ships a single standalone server that keeps its state in the built-in file storage backend; highly-available, multi-node topologies are a future refinement not modelled here. OpenBao is initialized and unsealed at runtime inside the cluster — its root token and unseal keys are produced by the running server after it starts — so the component declares no credential slot and no secret is materialized at render time. Realized on Kubernetes through its Helm Recipe; it has no standalone local-container form, so no Compose Recipe is provided. Exports its API endpoint host and port to consumers via the uses topology. OpenBao is distributed under the MPL-2.0 license. With `values.metrics_enabled` true the Recipe turns on OpenBao's Prometheus telemetry and publishes its address as `metrics_endpoint`. A scrape presents an OpenBao token, best one whose policy grants read and list on sys/metrics and nothing else.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:23c9c7fe8b974078b50334df9cd0a72089f9d6ae92c93cdc826439fb914da97b
Published
2026-11-10T10:13:49Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officialapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:f52d92728e93277b7e4fe852e6a2a331e14030515000abd0daa2f7495b42cd2c

Reference at this version

oci://hub.aggrega.ai/component/core/security/openbao:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
ui_enabledbooleantruenoWhether the OpenBao server serves its built-in web UI on the API endpoint. Leave on for interactive administration; set false to expose the HTTP API only.
metrics_enabledbooleanfalsenoTurns on OpenBao's own metrics, in the Prometheus format, at /v1/sys/metrics on the API port, and publishes their address as `metrics_endpoint`; while false that key is empty. Only an active server serves them, and only to a token whose policy grants read and list on sys/metrics.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
external_base_urlstring—noExternally reachable base URL of the secrets API, as assembled at the ingress tier — for example https://secrets.example.com. The server advertises this as its own API address: the address it hands a client to be redirected to, and the one its plugin backends are given as the server's own. Omitted, the Recipe advertises the server's pod address, which is reachable only from inside the cluster.
source_versionstring—noSource artifact version (Helm chart). Overrides the Recipe's default source version. Changing from default does not guarantee value mapping compatibility.
computeobject—no—
storageobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesIn-cluster DNS name of the Service fronting the secrets API. A consumer points its client's address at this name together with `port`.
portinteger—yesTCP port that Service accepts API requests on. The realization serves the project's own default, so a consumer reads this rather than hard-coding one.
protocolstring—noHow the published address is spoken to — `http`, the scheme a consumer composes its client address on.
metrics_endpointstring—noThe full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:8200/v1/sys/metrics`, the host being the server's Service name. Empty while values.metrics_enabled is false. A scrape asks for the Prometheus format with the parameter format=prometheus.
metrics_credential_requiredboolean—noWhether a scrape of `metrics_endpoint` must present a credential: true while values.metrics_enabled is true, because OpenBao answers its metrics only to a token, and false while no address is published. Present a token whose policy grants read and list on sys/metrics and nothing else, so the scraper reads the metrics and no secret.

Uses sockets

The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.

No uses sockets declared.

Attachment slots

Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.

No attachment slots declared.

Self-inject allowlist

No self-inject pipes declared.

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

This entity uses nothing in the catalog.

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy