Files
LibreQoS/docs/v2.0/requirements.md
T
2025-05-01 05:24:34 -06:00

19 KiB
Raw Blame History

System Requirements

LibreQoS can be run either on a dedicated physical server (bare metal) or as a VM. Ubuntu Server 24.04 is the supported operating system.

Physical Server (Bare Metal)

CPU

  • 2 or more CPU cores are required
  • Choose a CPU with high single-thread performance within your budget. Queuing is CPU-intensive, and requires high single-thread performance.

Single-thread CPU performance determines the maximum capacity of a single HTB (CPU core). This, in turn, affects the maximum capacity of any top-level node in the network hierarchy (e.g., top-level sites in your network). This also impacts the maximum speed plan you can offer customers within safe margins.

Top-Level Node Max

Throughput Single-Thread Score
1 Gbps 1000
2 Gbps 1500
3 Gbps 2000
5 Gbps 4000

Customer Plan Maximum

Throughput Single-Thread Score
100 Mbps 1000
250 Mbps 1250
500 Mbps 1500
1 Gbps 1750
2.5 Gbps 2000
5 Gbps 4000

Below is a table of approximate aggregate capacity, assuming a CPU with a single thread performance of 1000, 2000, 3000, or 4000:

CPU Cores Single-Thread Score: 1000 Single-Thread Score: 2000 Single-Thread Score: 3000 Single-Thread Score: 4000
2 1 Gbps 3 Gbps 5 Gbps 7 Gbps
4 3 Gbps 5 Gbps 9 Gbps 13 Gbps
6 4 Gbps 8 Gbps 14 Gbps 20 Gbps
8 5 Gbps 10 Gbps 18 Gbps 27 Gbps
16 10 Gbps 21 Gbps 36 Gbps 54 Gbps
32 21 Gbps 42 Gbps 72 Gbps 108 Gbps
64 42 Gbps 84 Gbps 144 Gbps 216 Gbps
128 84 Gbps 168 Gbps 288 Gbps

Hyper-threading

It is recommended to disable Hyper-Threading (Simultaneous Multi-Threading) in the BIOS/UEFI settings, as it can interfere with XDP processing.

Memory

  • Recommended RAM:
RAM (using CAKE) Max Subscribers
4 GB 1,000
8 GB 2,000
16 GB 5,000
32 GB 10,000
64 GB 20,000
128 GB 40,000

Disk Space

50 GB of disk space or more is generally recommended, both for servers and VM deployments.

Device Recommendations

Small Form Factor (1G to 10G)

Throughput 1 Gbps 2.5 Gbps 10 Gbps
Per Node / Per CPU Core 1 Gbps 2.5 Gbps 5 Gbps
Manufacturer Supermicro Supermicro Minisforum
Model SYS-E100-12T-H SYS-E102-13R-E MS-01
CPU Option i7-1185GRE Default i9-12900H
RAM Option 2x8GB 2x8GB 1x32GB
NIC Option Built-in Built-in Built-in
Extras USB-C RJ45 USB-C RJ45
Temp Range -30°C ~ 50°C 0°C ~ 40°C 0°C ~ 40°C
Temp Range (-22°F to 122°F) (32°F ~ 104°F) (32°F ~ 104°F)
ECC No No No
Power 12-24V DC 12-24V DC 19V DC

Rackmount Servers (10G to 100G)

Throughput 10 Gbps 10 Gbps 25 Gbps 50 Gbps 100 Gbps
Per Node / Per CPU Core 5 Gbps 5 Gbps 3 Gbps 3 Gbps 4 Gbps
Manufacturer Supermicro Dell Supermicro Supermicro Supermicro
Model SYS-511R-M PowerEdge R260 AS-1115S-FWTRT AS-1015SV-WTNRT AS -2015CS-TNR
CPU Option E-2488 E-2456 8534P 8534P 9745
RAM Option 1x32GB 1x32GB 4x16GB 2x64GB 4x64GB
NIC Option 10-Gigabit X710-BM2 (2 x SFP+) Intel X710-T2L (2 x 10G RJ45) Mellanox (2 x SFP28) Mellanox 100-Gigabit (2 x QSFP56) MCX653106A-HDAT
Temp Range 0°C ~ 40°C 5–40°C 0°C ~ 40°C 0°C ~ 40°C 0°C ~ 40°C
Temp Range (32°F ~ 104°F) (41–104°F) (32°F ~ 104°F) (32°F ~ 104°F) (32°F ~ 104°F)
ECC Yes Yes Yes Yes Yes
Power AC AC AC AC AC

Another cost-effective solution is to procure a used server from a reputable vendor, such as TheServerStore. Such vendors often stock servers capable of 10 Gbps throughput, for around $500 USD.

Network Interface Requirements

  • One management network interface completely separate from the traffic shaping interfaces. Usually this would be the Ethernet interface built in to the motherboard.
  • A Dedicated Network Interface Card for Two Shaping Interfaces

Officially supported Network Interface Cards for the two shaping interfaces are listed below:

NIC Controller Port Speed Suggested Models Known Issues
Intel X520 10 Gbps Module compatibility*
Intel X710 10 Gbps X710-BM2 10G Module compatibility*
Intel XXV710 10 / 25 Gbps XXV710 25G Module compatibility*
Intel XL710 10 / 40 Gbps XL710-BM2 40G Module compatibility*
Mellanox ConnectX-4 Lx 10/25/40/50 Gbps No known issues.
Mellanox ConnectX-6 10/25 Gbps MCX631102AN-ADAT No known issues.
Mellanox ConnectX-6 100 Gbps MCX623106AN-CDAT 100G No known issues.
Mellanox ConnectX-7 200 Gbps MCX755106AS-HEAT 200G No known issues.

(*) Intel often vendor-locks SFP+ module compatibility. Check module compatibility before buying. Mellanox does not have this problem.

We will ONLY provide support for systems using a NIC listed above. Some other NICs may work, but will not be officially supported by LibreQoS. If you want to test the compatability of another card, please be aware of these fundamental NIC requirements:

If you discover that a card not listed in the table above is compatible, please let us know by emailing support [at] libreqos.io.

Virtual Machine

LibreQoS can be run as a VM, although this comes at a performance penalty of 30%. For VMs, NIC passthrough is required to achieve throughput above 10 Gbps (XDP vs generic XDP). LibreQoS requires 2 or more RX/TX queues, so when using a virtualization platform such as Proxmox, be sure to enable Multiqueue for the shaping interfaces assigned to the VM. Multiqueue should be set equal to the number of vCPU cores assigned to the VM.

Throughput vCPU* RAM Disk
1 Gbps 2 8 GB 50 GB
10 Gbps 8 32 GB 50 GB
  • Assumes vCPU performance equal to a single core of the Intel Xeon E-2456 with hyper-threading disabled.