Component

core/messaging/nats

A NATS messaging server for pub-sub, request-reply, and queueing. In this lean shape NATS routes subjects in memory with no durable persistence (JetStream file storage is not enabled), so the component renders as a stateless workload rather than a stateful one and declares no storage. Authentication is off by default; when a credential is attached to the optional password slot, each Recipe enables user/password authentication and wires the credential through the credential subsystem. Provider-agnostic: the same component is implemented by a Helm Recipe (Workload synthesis to native Kubernetes resources) and a Compose Recipe (local development). Exports its host and client port to consumers via the uses topology. On Kubernetes there are two realizations and the Manifest chooses between them. `nats` synthesizes the server as a workload and fetches nothing, so it is the one to reach for where the build must complete with no chart repository reachable. `nats-chart` renders the product's own Helm chart, which additionally carries a sidecar that reloads the server configuration in place, start-up, readiness and liveness probes against the monitoring endpoint, and a drain-then-shut-down sequence that lets connected clients move off before the pod goes away — and it is the realization that honours `monitoring_port`, so reach for it where a chart repository is reachable at build time.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:6442f87145c50476deb4c047562136eece91faa7a3ebc101d7ec4458916f1e5e
Published
2026-11-10T10:12:28Z
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:90bd8f7234f43e27af901a28509adea5872dc136a2a8965ba80f287a2ee77ce2

Reference at this version

oci://hub.aggrega.ai/component/core/messaging/nats:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
userstringnats_clientnoClient user provisioned for authenticated connections. Used only when a password credential is attached to the optional password slot; ignored when the server runs without authentication.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)4222noClient listen port. Most operators should omit this and let the Recipe assign the default (4222).
monitoring_portinteger (min 1024, max 65535)8222noHTTP monitoring endpoint port. Most operators should omit this and let the Recipe assign the default (8222). Read by the chart-backed realization, which serves the endpoint and aims its probes at it; the workload-synthesis and Compose realizations expose no monitoring endpoint and ignore it.
engine_versionstring2.11-alpinenoNATS container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag.
source_versionstring—noVersion of the Helm chart the chart-backed realization pulls. Read only by that realization; the workload-synthesis and Compose realizations pull no source artifact and ignore it. Changing it away from the Recipe's default does not guarantee value-mapping compatibility with the new chart.
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—yesIn-cluster DNS name of the Service fronting the server. A publisher or subscriber puts this name in its client's server list together with `port`.
portinteger—yesTCP port the server accepts client connections on. It carries the client port an operator set, never the monitoring port.
protocolstring—noWire protocol the published address speaks — `nats`, which is what a consumer selects a client library for.

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.

SlotSelectorRequiredInjectSensitiveDescription
passwordfeature.aggrega.ai/kind=secretnoenvyesOptional server authentication credential. When attached, enables NATS user/password authentication and supplies the password; unattached, the server runs without authentication.

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

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