Esta página foi traduzida automaticamente. Ler o original em inglês.

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.

Proveniência

OficialAssinado por uma identidade de assinatura que este catálogo reconhece como editor oficial.
Digest do conteúdo
sha256:bd3375d60235bfff68b81e6f6bdf789dcfe3a506cf77a03a80c3aba13c12cbbf
Publicado
2026-11-10T10:10:42Z
Identidade de assinatura
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Assinatura

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

Referência nesta versão

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

Parâmetros do programador

Valores que o programador define no Aggregate.

NomeTipoPredefiniçãoObrigatórioDescrição
metrics_enabledbooleanfalsenãoMakes 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.

Dimensionamento do operador

Dimensionamento da infraestrutura que o operador ajusta por ambiente.

NomeTipoPredefiniçãoObrigatórioDescrição
portinteger (min 1024, max 65535)27017nãoDocument-database wire port the proxy listens on. Most operators should omit this and let the Recipe assign the default (27017).
engine_versionstring2.7.0nãoProxy container image tag.
computeobject—não—
overridesobject (open)—nãoProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Contrato de saída

Valores que este componente publica para os consumidores através da topologia uses.

NomeTipoPredefiniçãoObrigatórioDescrição
hoststring—simAddress a client opens its document-database connection to. On the in-cluster realizations it is the Service's DNS name.
portinteger—simTCP 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—nãoWire 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—nãoThe 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

Os sockets de dependência através dos quais este componente se liga. O destino de cada ligação estabelecida através de um socket tem de satisfazer o respetivo seletor de etiquetas, e cada ligação pode transportar um acoplamento nos slots que o socket declara. Cada ligação que o Aggregate ou a Release estabelece através do socket tem de preencher os slots obrigatórios.

backend

Seletor
component.aggrega.ai/type=stateful-server
Injeção
env

Slots que cada ligação através deste socket pode preencher

SlotSeletorObrigatórioInjeçãoSensívelDescrição
credentialfeature.aggrega.ai/kind=secretnãoenvsimOptional 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.

Slots de acoplamento

Pontos de vinculação com nome nos quais uma Feature se acopla a este componente. O seletor de um slot restringe qual a Feature que o pode preencher, e a respetiva lista inject indica como o material da Feature pode ser entregue. Um slot obrigatório tem de estar vinculado em cada instância, por um acoplamento na instância ou num âmbito acima dela, e um slot sensível é declarado para tratar material secreto. Uma Feature também se pode acoplar com um nome que nenhum slot declara.

Nenhum slot de acoplamento declarado.

Lista de autorizações de autoinjeção

env

Relações

Arestas tipadas de e para outras entidades publicadas. Uma referência sem destino publicado é apresentada como uma aresta quebrada em vez de uma ligação.

Usa

Usado por

Referência do conceito Component →

O catálogo Aggrega — um índice aberto de componentes, funcionalidades, receitas e dos plugins que os renderizam.

Criado com o sistema de design partilhado do Aggrega.

Privacidade