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
- Empreinte du contenu
- sha256:bd3375d60235bfff68b81e6f6bdf789dcfe3a506cf77a03a80c3aba13c12cbbf
- Publié
- 2026-11-10T10:10:42Z
- Identité de signature
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Signature
- Officielapplication/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
Référence à cette version
oci://hub.aggrega.ai/component/core/datastore/ferretdb:1.0.0Paramètres du développeur
Valeurs que le développeur définit dans l’Aggregate.
| Nom | Type | Valeur par défaut | Obligatoire | Description |
|---|---|---|---|---|
| metrics_enabled | boolean | false | non | Makes 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. |
Dimensionnement de l’opérateur
Dimensionnement de l’infrastructure que l’opérateur ajuste pour chaque environnement.
| Nom | Type | Valeur par défaut | Obligatoire | Description |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 27017 | non | Document-database wire port the proxy listens on. Most operators should omit this and let the Recipe assign the default (27017). |
| engine_version | string | 2.7.0 | non | Proxy container image tag. |
| compute | object | — | non | — |
| overrides | object (open) | — | non | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Contrat de sortie
Valeurs que ce composant publie vers les consommateurs via la topologie uses.
| Nom | Type | Valeur par défaut | Obligatoire | Description |
|---|---|---|---|---|
| host | string | — | oui | Address a client opens its document-database connection to. On the in-cluster realizations it is the Service's DNS name. |
| port | integer | — | oui | TCP 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. |
| protocol | string | — | non | Wire 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_endpoint | string | — | non | The 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. |
Sockets uses
Les sockets de dépendance par lesquels ce composant se connecte. La cible de chaque connexion câblée via un socket doit satisfaire son sélecteur d’étiquettes, et chaque connexion peut porter une attache dans les emplacements que le socket déclare. Un emplacement obligatoire doit être rempli par chaque connexion que l’Aggregate ou la Release câble via le socket.
backend
- Sélecteur
- component.aggrega.ai/type=stateful-server
- Injection
- env
Emplacements que chaque connexion passant par ce socket peut remplir
| Emplacement | Sélecteur | Obligatoire | Injection | Sensible | Description |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | non | env | oui | Optional 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. |
Emplacements d’attache
Points de liaison nommés auxquels une Feature s’attache à ce composant. Le sélecteur d’un emplacement restreint la Feature qui peut le remplir, et sa liste inject indique comment le matériel de la Feature peut être livré. Un emplacement obligatoire doit être lié sur chaque instance, par une attache sur l’instance ou à une portée supérieure, et un emplacement sensible est déclaré pour traiter du matériel secret. Une Feature peut aussi s’attacher sous un nom qu’aucun emplacement ne déclare.
Aucun emplacement d’attache déclaré.
Liste d’autorisation d’auto-injection
env
Relations
Arêtes typées vers et depuis d’autres entités publiées. Une référence sans cible publiée s’affiche comme une arête rompue plutôt que comme un lien.
Utilise
- utiliseutilise le socket « backend »
component.aggrega.ai/type=stateful-server
Emplacements d’attache : credential
core/ai-agent/dify-plugin-daemon v1.0.0 →core/ai-tool/filesystem v1.0.0 →core/datastore/chroma v1.0.0 →core/datastore/cognee v1.0.0 →core/datastore/documentdb v1.0.0 →core/datastore/elasticsearch v1.0.0 →core/datastore/etcd v1.0.0 →core/datastore/mariadb v1.0.0 →core/datastore/milvus v1.0.0 →core/datastore/mysql v1.0.0 →core/datastore/mysql-innodb-cluster v1.0.0 →core/datastore/opensearch v1.0.0 →core/datastore/pgvector v1.0.0 →core/datastore/postgres v1.0.0 →core/datastore/qdrant v1.0.0 →core/datastore/timescaledb v1.0.0 →core/datastore/weaviate v1.0.0 →core/devtool/harbor v1.0.0 →core/messaging/kafka v1.0.0 →core/messaging/rabbitmq v1.0.0 →core/observability/fluentd v1.0.0 →core/observability/jaeger v1.0.0 →core/observability/loki v1.0.0 →core/observability/prometheus v1.0.0 →core/observability/tempo v1.0.0 →core/security/openbao v1.0.0 →
Utilisé par
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « queue »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « state_store »
utilise le socket « checkpointer_db »
utilise le socket « checkpointer_db »
utilise le socket « backend »
utilise le socket « backend »
utilise le socket « backend »
utilise le socket « storage »
utilise le socket « metadata_store »
utilise le socket « target_datastore »
utilise le socket « databases »
utilise le socket « etcd »
utilise le socket « backend »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « state_store »
utilise le socket « forward_target »
utilise le socket « backend »
utilise le socket « cache »
utilise le socket « chunk_cache »
utilise le socket « scrape_target »
utilise le socket « backend »
utilise le socket « backend »
utilise le socket « database »
s’applique à
s’applique à
s’applique à
implémente
implémente