LiveKit Ingress (livekit-ingress)

Optional, not needed by the telephony: imports RTMP and WHIP streams (encoders, OBS, webinars) into LiveKit rooms. Install it only for broadcasts; phone calls go through LiveKit SIP.

Generated from catalog/services/livekit-ingress.yaml: do not edit by hand.

Summary

Version	1.5.0
Use	install and configure
Layer	functional (AI catalog)
Category	AI serving
Installation methods	podman
External connection	no
Sandbox only	no

Licence

SPDX identifier	Apache-2.0
Licence policy	core licence (MIT or Apache-2.0)
Licence exception	-
Licence exceptions of its dependencies	LEX-033 (pending, awaiting the client)
Platform component	livekit-ingress

Packages and artifacts

A package the project of the service publishes (its image, its binary archive, its Python or OS package) carries the licence of the service; a third-party package carries the licence written on its row, read from the official upstream metadata.

Kind	Package	Version	Licence	Details
container image	docker.io/livekit/ingress	v1.5.0	Apache-2.0	image key ingress, used by ingress, digest sha256:2e1d3fcf10bfaebddaea74dc8b965410cda6377ed154451361b86ab3a9ee9f99

Images are pinned by tag in the descriptor, and by digest when the descriptor declares one (the offline bundle then refuses a pulled image that does not carry it); the digest is recorded in the mirror of the Manager when the offline bundle is imported, and every pull or load is checked against it.

Supported systems and architectures

Method	Operating systems	Architectures
podman	RHEL family (dnf), Debian family (apt), Arch Linux (pacman)	x86_64, aarch64 (not restricted by the descriptor)

Certified host systems: RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). The host preflight accepts these systems (other releases of a known family give a warning, end of life releases are refused) and the x86_64 and aarch64 architectures.

Prerequisites

Host

• at least 4 CPU (warning, cpu).
• at least 4096 MB of memory (warning, memory).

Network and ports

Component	Port name	Port	Opened in the host firewall
ingress	rtmp	1935/tcp	yes
ingress	whip	8086/tcp	yes
ingress	whip-media	7885/udp	yes
ingress	health	8593/tcp	no
ingress	metrics	6792/tcp	yes

Services and connections needed

• livekit: livekit.
• redis: redis.

Details and resolution: see Dependencies.

Installation methods and modes

Method	Default	What the method uses
podman	yes	the container images of the descriptor, run by Podman under systemd

Components

Component	Kind	Installation methods	Ports
Ingress (ingress)	worker	podman	1935/tcp, 8086/tcp, 7885/udp, 8593/tcp, 6792/tcp

Single instance (single) (default)

One ingress instance.

What the mode deploys:

Component	Placement
ingress	min 1, max 1

Pool (pool)

Several instances behind a TCP load balancer (RTMP) or an HTTP reverse proxy (WHIP).

What the mode deploys:

Component	Placement
ingress	min 2, recommended 2

Install this service

The install wizard of the Navin Manager plans, validates and runs the installation; you need the services:install permission on the cluster.

1. Open the wizard. In Clusters, choose the row action Install services of the target cluster. The wizard opens on its first step, Service.

2. Choose the service. On the Service step, select LiveKit Ingress. The card shows the licence Apache-2.0 and the dependencies the installation needs.

3. Choose the hosts and the mode. On the Hosts step, tick the hosts, then choose the Mode: single (default), pool. Each mode deploys the components listed in Installation methods and modes.

4. Bind the dependencies. On the Bindings step, choose for each dependency (livekit, redis) Install with the platform or Use an existing connection; an optional dependency can stay on No binding.

5. Configure. On the Configure step, review the parameters (see Configuration parameters). Passwords left empty with a generated default are generated and sealed by the Manager.

6. Review and install. On the Install step the Manager validates the plan and shows the installation order; when it says "The plan is valid. Ready to install.", choose Install. A highly available mode is installed only when its HA checks pass.

7. Verify. The operation ends when the health checks of every instance pass (see Health checks); the service then shows as running in Services.

High availability

Cluster	none (none)
High availability	redundancy (redundancy)
Failover	load balancer (load-balancer)
Replication	none (none)
Quorum	none (none)
Discovery	registry (registry)
Entry point	load balancer (load-balancer)
Official documentation	https://docs.livekit.io/transport/self-hosting/ingress/
References	https://github.com/livekit/ingress

Prerequisites

Prerequisite	Must be highly available	Modes	Description
redis	yes	pool	Highly available Redis shared with LiveKit Server.

Topology per mode

Modes	Highest catalog level	Distribution	Quorum component	Fault domains	Description
single	standalone (standalone)	single (single)	-	1	One instance, no fault tolerance.
pool	ha (ha)	active-active (active-active)	-	2	Several instances behind a load balancer that checks their availability endpoint.

Notes

• A stream runs on one instance: the loss of that instance cuts the stream, the encoder reconnects through the load balancer.

Configuration parameters

Network

Parameter	Type	Default	Allowed values	Required	Secret	Restart	Description
RTMP port (rtmp_port)	port	1935	-	no	no	yes	RTMP listener (TLS at the load balancer).
WHIP port (whip_port)	port	8086	-	no	no	yes	WHIP HTTP listener (TLS at the reverse proxy).
WHIP media port (ice_udp_port)	port	7885	-	no	no	yes	Single UDP port of the WHIP media (ICE).
Health port (health_port)	port	8593	-	no	no	no	Health (/) and availability (/availability), local to the host.
Metrics port (metrics_port)	port	6792	-	no	no	no	Prometheus port.
LiveKit URL (livekit_url)	string	(empty)	-	no	no	no	ws:// or wss:// URL of LiveKit Server; empty: the first server of the livekit binding.

Dependencies

For each active dependency the Manager takes the first of: the binding chosen in the wizard; a service of the same installation that provides it; a service already installed in the cluster; the only connection of the expected type. Otherwise an optional dependency stays unbound, and a required one is added to the installation in its default mode (the column below names the catalog service added).

Binding	Provided by	Connection type	Endpoint	Optional	When nothing is bound	Description
livekit	livekit	-	signal	no	livekit is added to the installation	LiveKit Server of the rooms (its redis_bus must be on, and its ingress base URLs point to this service).
redis	redis	redis	redis	no	redis is added to the installation	The Redis of LiveKit Server.

Commands

Command	Component	Target	Description
Recent logs (logs)	ingress	chosen host	Last lines of the ingress journal.

Health checks

Liveness (per instance)

Component	Check	Details
ingress	HTTP http://127.0.0.1:{{ config.health_port }}/	Expected 200; 60 retries; interval 2 s; timeout 3 s

Preflight checks

Check	Type	Meaning	Severity	Components
cpu	cpu_count {"min": 4}	at least 4 CPU	warning	every component
memory	memory_mb {"min": 4096}	at least 4096 MB of memory	warning	every component

Uninstall

Paths removed when the data is purged: {{ paths.log }}.

Upstream documentation

• Homepage: https://docs.livekit.io/transport/self-hosting/ingress/
• Source: https://github.com/livekit/ingress
• High availability: https://docs.livekit.io/transport/self-hosting/ingress/
• High availability: https://github.com/livekit/ingress