Component
core/datastore/documentdb
A PostgreSQL-backed document store: PostgreSQL 17 with the DocumentDB extension. It presents the standard PostgreSQL wire contract (POSTGRES_USER / POSTGRES_PASSWORD / POSTGRES_DB) and persists data on a volume, so it is a stateful server. It is the storage backend for a document proxy that speaks a document-database wire protocol on top of it; the proxy connects over the exported host, port, user, and database. Exports its host, port, user, database, and protocol to consumers via the uses topology.
Provenance
- Content digest
- sha256:8f0098d60a8139139f99ea1d548e2ce9fcdf57ae40e8e89e208daf82dd92e4a2
- Published
- 2026-11-10T10:10:33Z
- 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:9bd69b3849e2f834bf9c38c463c7f4c072cde4377dbabbe90e39b1a8da422254
Reference at this version
oci://hub.aggrega.ai/component/core/datastore/documentdb:1.0.0Developer parameters
Values the developer sets in the Aggregate.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| user | string | postgres | no | Application database user created on startup (POSTGRES_USER). |
| database | string | postgres | no | Logical database name created on startup (POSTGRES_DB). |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 5432 | no | Server listen port. Most operators should omit this and let the Recipe assign the default (5432). |
| engine_version | string | 17-0.107.0-ferretdb-2.7.0 | no | Backend image tag (PostgreSQL major version plus the DocumentDB extension build). |
| compute | object | — | no | — |
| storage | object | — | no | — |
| overrides | object (open) | — | no | Provider-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.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| host | string | — | yes | Address a client opens its database connection to. On the in-cluster realizations it is the Service's DNS name. |
| port | integer | — | yes | TCP port the server accepts connections on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default. |
| user | string | — | no | Name of the application login role created at startup. A consumer authenticates as this role; the matching password arrives through the credential attached to the component, never through this contract. |
| database | string | — | no | Name of the logical database created at startup. A consumer names it in its connection string to land in the right database rather than the server's default. |
| protocol | string | — | no | Wire protocol the published address speaks — `postgres`, so a consumer chooses a PostgreSQL client even though what it stores is documents. |
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.
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| password | feature.aggrega.ai/kind=secret | no | env | yes | Optional database password credential. When attached, supplies POSTGRES_PASSWORD via the credential subsystem. Unattached, compose/documentdb and helm/documentdb set POSTGRES_PASSWORD to the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password. |
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
This entity uses nothing in the catalog.
Used by
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «state_store»
uses socket «checkpointer_db»
uses socket «checkpointer_db»
uses socket «backend»
uses socket «backend»
uses socket «backend»
uses socket «storage»
uses socket «metadata_store»
uses socket «target_datastore»
uses socket «backend»
uses socket «databases»
uses socket «etcd»
uses socket «backend»
uses socket «backend»
uses socket «cache»
uses socket «state_store»
uses socket «forward_target»
uses socket «backend»
uses socket «cache»
uses socket «chunk_cache»
uses socket «scrape_target»
uses socket «backend»
uses socket «backend»
uses socket «database»
applies to
applies to
applies to
implements
implements