Component

core/datastore/ferretdb

A document-database proxy that speaks the MongoDB wire protocol and stores data in a PostgreSQL backend with the DocumentDB extension. It is typed as a stateful server because the endpoint it presents to consumers is a durable document database: standard database consumers bind it through their database socket exactly as they would a native datastore. The proxy process itself holds no local state — its Recipe renders a stateless workload — but the service contract it exposes is a database, so the type label reflects the consumer-facing contract rather than the internal workload form. It fronts a PostgreSQL/DocumentDB backend wired through its `backend` uses-socket: the backend host, port, user, and database arrive on the injection context and are composed into the proxy's PostgreSQL connection. Exports its host, port, and protocol to consumers via the uses topology. With `values.metrics_enabled` true each Recipe makes FerretDB's own metrics, served at /debug/metrics on its debug listener, port 8088, reachable and publishes that address as `metrics_endpoint`; false, that key is empty. That listener checks no caller and also serves /debug/pprof, with CPU profiles and execution traces on request, /debug/vars, /debug/archive and /debug/graphs. On Kubernetes the value moves it from the pod's loopback address onto every interface of the pod and names its port on the Service, newly opening it to every in-cluster caller that reaches the pod; on Docker Compose the value newly opens it to every peer on the network.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:bd3375d60235bfff68b81e6f6bdf789dcfe3a506cf77a03a80c3aba13c12cbbf
Published
2026-11-10T10:10:42Z
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:1fb1023e5afe692195099eabce8cb8fb76855155007b04488ae50867baf42322

Reference at this version

oci://hub.aggrega.ai/component/core/datastore/ferretdb:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
metrics_enabledbooleanfalsenoMakes FerretDB's own metrics, in the Prometheus format at /debug/metrics on port 8088, reachable and publishes their address as `metrics_endpoint`; while false that key is empty. The port checks no caller and also serves /debug/pprof (CPU profiles and execution traces on request), /debug/vars, /debug/archive and /debug/graphs. On Kubernetes the value moves the listener from the pod's loopback address onto every interface and names its port on the Service, newly opening it to every in-cluster caller that reaches the pod; on Docker Compose the value newly opens it to every peer on the network.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)27017noDocument-database wire port the proxy listens on. Most operators should omit this and let the Recipe assign the default (27017).
engine_versionstring2.7.0noProxy container image tag.
computeobject—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—yesAddress a client opens its document-database connection to. On the in-cluster realizations it is the Service's DNS name.
portinteger—yesTCP port the proxy accepts connections on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
protocolstring—noWire protocol the published address speaks — `mongodb`, so a consumer uses a MongoDB driver and never has to know a PostgreSQL backend is behind it.
metrics_endpointstring—noThe full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:8088/debug/metrics`, the host being the proxy's Service name. Empty while values.metrics_enabled is false.

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.

backend

Selector
component.aggrega.ai/type=stateful-server
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretnoenvyesOptional password the proxy presents to the backend this connection reaches, shared with that backend. When attached, supplies the backend password via the credential subsystem. Unattached, compose/ferretdb and helm/ferretdb present the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password.

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

env

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

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