Component

core/messaging/livekit-sip

A LiveKit SIP bridge — the service that carries a telephone call into and out of a realtime room. It answers SIP signalling on one port, which it binds for datagram and stream transport alike, negotiates the call there, and then carries the call audio over RTP on a contiguous range of UDP ports it draws a per-call socket from. The room side of the call runs over the bridge's own client session with the media server, and the state of a call in progress lives in the Redis-compatible store the bridge and that server share, which is also how the requests that set a call up pass between them. Wire here when a SIP trunk is terminated inside the cluster and those calls are joined to rooms it already runs, rather than routing the conversation through a carrier's own application platform. Consumers receive the bridge's in-cluster host, its signalling port and the protocol that port speaks; the token-signing secret is the credential the connection to the media server carries and is never published on the topology, and the public key identifier arrives over that same edge, so the halves of one key pair cannot drift apart. Realized by a Helm Recipe that synthesizes a Deployment and a ClusterIP Service over the upstream image and declares no volume: the bridge holds no durable disk. The RTP range carries call audio only where the pod uses the node's own network and the range is open to the trunk on the node's firewall. With `values.metrics_enabled` true the Recipe turns on the bridge's metrics, on a port of their own that checks no caller, and publishes their address as `metrics_endpoint`; false, that key is empty.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:0457bf114748999273e7f053a4837b34cf5b5971d95d6e7229d44054551f06c4
Published
2026-11-10T10:12:26Z
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:40b012f2a7a1df4b3aff4b1b10192d6463192e84f4d2debf2ded1caf7123f082

Reference at this version

oci://hub.aggrega.ai/component/core/messaging/livekit-sip:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
metrics_enabledbooleanfalsenoTurns on the bridge's own metrics, in the Prometheus format, on a port of their own, 6789, and publishes their address as `metrics_endpoint`; while false that key is empty. The metrics port checks no caller, so anything that reaches it can read them.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
sip_portinteger (min 1024, max 65535)5060noSIP signalling port. The bridge binds it for UDP and for TCP together and announces it in the SIP headers it sends, so both transports of the trunk arrive on one number. Most operators should omit this and let the Recipe assign the default (5060).
health_portinteger (min 1024, max 65535)8080noPort carrying the bridge's own health endpoint, which answers with the load state of the process. The Recipe probes it, so leaving it at the default keeps the readiness and liveness checks working; it is a container port and the Service does not publish it.
rtp_port_startinteger (min 1024, max 65535)10000noFirst port of the contiguous UDP range the bridge draws a per-call RTP socket from. The range sizes how many calls one replica carries at once, since each call holds a socket in it for its duration. The ports in it are configuration the bridge reads rather than ports the component declares — they are not container ports and no Service fronts them — so they carry call audio where the pod uses the node's own network and the range is open to the trunk on the node's firewall.
rtp_port_endinteger (min 1024, max 65535)20000noLast port of the contiguous UDP RTP range, inclusive, and greater than rtp_port_start. Narrow the range to the number of concurrent calls a replica is sized for rather than leaving the full default span open on the node.
log_levelstring (debug | info | warn | error)infonoBridge log verbosity.
engine_versionstringv1.12.0noBridge container image tag. Selects the image tag on container targets.
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 carrying SIP signalling. A consumer directs call signalling at this name together with `port`; the RTP range is a separate path and is not published here.
portinteger—yesPort the bridge answers SIP signalling on. It carries the signalling port an operator set, never the health port or one of the RTP ports.
protocolstring—noHow the published address is spoken to — `sip`, so a consumer directs call signalling at it rather than an HTTP request.
metrics_endpointstring—noThe full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:6789/metrics`. Empty while values.metrics_enabled is false.

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.

media_server

Selector
component.aggrega.ai/category=messaging, component.aggrega.ai/type=server
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretyesenvyesSigning secret paired with the api_key identifier this connection carries. Attach the same credential the media server holds: the bridge authenticates to that server with this pair, so two different secrets leave the bridge unable to open a session.

state_store

Selector
component.aggrega.ai/category=datastore, datastore.aggrega.ai/engine=kv
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
server_cafeature.aggrega.ai/kind=secretnofileyesOptional authority the bridge checks the store's certificate against while the store publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Recipe mounts the whole Secret read-only and names the file in the bridge's store settings. The build halts on a server_ca publishing no Secret name, and on one wired to a store served without TLS. Fill it with core/referenced-secret.

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.

No attachment slots declared.

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

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