Diese Seite wurde maschinell übersetzt. Englisches Original lesen.

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.

Herkunft

OffiziellSigniert von einer Signaturidentität, die dieser Katalog als offiziellen Herausgeber anerkennt.
Inhalts-Digest
sha256:bd3375d60235bfff68b81e6f6bdf789dcfe3a506cf77a03a80c3aba13c12cbbf
Veröffentlicht
2026-11-10T10:10:42Z
Signaturidentität
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signatur

  • Offiziellapplication/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

Referenz zu dieser Version

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

Entwicklerparameter

Werte, die der Entwickler im Aggregate festlegt.

NameTypStandardwertErforderlichBeschreibung
metrics_enabledbooleanfalseneinMakes 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.

Dimensionierung durch den Operator

Infrastrukturdimensionierung, die der Operator pro Umgebung anpasst.

NameTypStandardwertErforderlichBeschreibung
portinteger (min 1024, max 65535)27017neinDocument-database wire port the proxy listens on. Most operators should omit this and let the Recipe assign the default (27017).
engine_versionstring2.7.0neinProxy container image tag.
computeobject—nein—
overridesobject (open)—neinProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Ausgabevertrag

Werte, die diese Komponente über die uses-Topologie an Konsumenten veröffentlicht.

NameTypStandardwertErforderlichBeschreibung
hoststring—jaAddress a client opens its document-database connection to. On the in-cluster realizations it is the Service's DNS name.
portinteger—jaTCP 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—neinWire 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—neinThe 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

Die Abhängigkeits-Sockets, über die sich diese Komponente verbindet. Das Ziel jeder über einen Socket verdrahteten Verbindung muss dessen Label-Selektor erfüllen, und jede Verbindung kann in den Slots, die der Socket deklariert, eine Anbindung tragen. Einen erforderlichen Slot muss jede Verbindung füllen, die das Aggregate oder das Release über den Socket verdrahtet.

backend

Selektor
component.aggrega.ai/type=stateful-server
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credentialfeature.aggrega.ai/kind=secretneinenvjaOptional 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.

Anbindungs-Slots

Benannte Bindungspunkte, an denen ein Feature an diese Komponente angebunden wird. Der Selektor eines Slots schränkt ein, welches Feature ihn füllen darf, und seine inject-Liste benennt, wie das Feature sein Material liefern darf. Ein erforderlicher Slot muss auf jeder Instanz gebunden sein, durch eine Anbindung an der Instanz oder in einem darüberliegenden Geltungsbereich, und ein sensibler Slot ist für den Umgang mit geheimem Material deklariert. Ein Feature kann auch unter einem Namen angebunden werden, den kein Slot deklariert.

Keine Anbindungs-Slots deklariert.

Zulassungsliste für Selbstinjektion

env

Beziehungen

Typisierte Kanten zu und von anderen veröffentlichten Entitäten. Eine Referenz ohne veröffentlichtes Ziel wird als unterbrochene Kante statt als Link dargestellt.

Verwendet

Verwendet von

Konzeptreferenz zu Component →

Der Aggrega-Katalog — ein offener Index von Komponenten, Funktionen, Rezepten und den Plugins, die sie rendern.

Erstellt mit dem gemeinsamen Aggrega-Designsystem.

Datenschutz