LibreQoS/README.md

81 lines
5.2 KiB
Markdown
Raw Normal View History

2022-11-20 10:28:39 -06:00
<a href="https://libreqos.io/"><img alt="LibreQoS" src="https://user-images.githubusercontent.com/22501920/202913614-4ff2e506-e645-4a94-9918-d512905ab290.png"></a>
2022-09-04 15:35:38 -05:00
LibreQoS is a Quality of Experience (QoE) Smart Queue Management (SQM) system designed for Internet Service Providers to optimize the flow of their network traffic and thus reduce bufferbloat, keep the network responsive, and improve the end-user experience.
2022-09-11 14:30:40 -05:00
2022-10-21 08:40:25 -05:00
Servers running LibreQoS can shape traffic for many thousands of customers.
2022-09-11 14:30:40 -05:00
2022-11-17 16:09:16 -06:00
Learn more at [LibreQoS.io](https://libreqos.io/)!
2022-09-07 12:18:52 -05:00
2022-09-13 10:16:37 -05:00
## Features
2022-11-17 16:09:16 -06:00
### Flexible Hierarchical Shaping / Back-Haul Congestion Mitigation
2022-09-12 23:40:39 -05:00
<img src="https://raw.githubusercontent.com/rchac/LibreQoS/main/docs/nestedHTB2.png" width="350"></img>
2022-11-20 10:28:39 -06:00
Starting in version v1.1+, operators can map their network hierarchy in LibreQoS. This enables both simple network hierarchies (Site>AP>Client) as well as much more complex ones (Site>Site>Micro-PoP>AP>Site>AP>Client). This can be used to ensure that a given sites peak bandwidth will not exceed the capacity of its back-haul links (back-haul congestion control). Operators can support more users on the same network equipment with LibreQoS than with competing QoE solutions which only shape by AP and Client.
2022-09-12 23:40:39 -05:00
### CAKE
2022-11-20 10:28:39 -06:00
CAKE is the product of nearly a decade of development efforts to improve on fq_codel. With the diffserv_4 parameter enabled CAKE groups traffic in to Bulk, Best Effort, Video, and Voice. This means that without having to fine-tune traffic priorities as you would with DPI products CAKE automatically ensures your clients OS update downloads will not disrupt their zoom calls. It allows for multiple video conferences to operate on the same connection which might otherwise “fight” for upload bandwidth causing call disruptions. It holds the connection together like glue. With work-from-home, remote learning, and tele-medicine becoming increasingly common minimizing video call disruptions can save jobs, keep students engaged, and help ensure equitable access to medical care.
2022-09-12 23:40:39 -05:00
### XDP
2022-11-20 10:28:39 -06:00
Fast, multi-CPU queueing leveraging xdp-cpumap-tc and cpumap-pping. Currently tested in the real world past 11 Gbps (so far) with just 30% CPU use on a 16 core Intel Xeon Gold 6254. It's likely capable of 30Gbps or more.
2022-09-12 23:40:39 -05:00
### Graphing
2022-11-20 10:28:39 -06:00
You can graph bandwidth and TCP RTT by client and node (Site, AP, etc), with great visalizations made possible by InfluxDB.
2022-10-21 08:58:11 -05:00
<img alt="LibreQoS" src="https://raw.githubusercontent.com/rchac/LibreQoS/main/docs/v1.1-alpha-preview.jpg"></a>
2022-09-12 12:34:17 -05:00
2022-10-19 21:31:57 -05:00
### CRM Integrations
* UISP
* Splynx
2022-10-19 21:31:57 -05:00
2022-09-07 12:18:52 -05:00
## System Requirements
2022-11-17 16:11:41 -06:00
### VM or physical server
* For VMs, NIC passthrough is required for optimal throughput and latency (XDP vs generic XDP). Using Virtio / bridging is much slower than NIC passthrough. Virtio / bridging should not be used for large amounts of traffic.
2022-10-21 08:35:27 -05:00
### CPU
2022-10-21 07:59:50 -05:00
* 2 or more CPU cores
2022-10-21 08:35:27 -05:00
* A CPU with solid [single-thread performance](https://www.cpubenchmark.net/singleThread.html) within your budget.
2022-10-22 17:49:12 -05:00
* For 10G+ throughput on a budget, consider the [AMD Ryzen 9 5900X](https://www.bestbuy.com/site/amd-ryzen-9-5900x-4th-gen-12-core-24-threads-unlocked-desktop-processor-without-cooler/6438942.p?skuId=6438942) or [Intel Core i7-12700KF](https://www.bestbuy.com/site/intel-core-i7-12700kf-desktop-processor-12-8p-4e-cores-up-to-5-0-ghz-unlocked-lga1700-600-series-chipset-125w/6483674.p?skuId=6483674)
* CPU Core count required assuming [single thread](https://www.cpubenchmark.net/singleThread.html) performance of 2700 or more:
2022-10-21 08:35:27 -05:00
| Throughput | CPU Cores |
| ------------- | ------------- |
2022-10-22 17:49:12 -05:00
| 500 Mbps | 2 |
2022-10-21 08:35:27 -05:00
| 1 Gbps | 4 |
| 5 Gbps | 8 |
| 10 Gbps | 12 |
2022-10-22 17:49:12 -05:00
| 20 Gbps* | 16 |
| 50 Gbps* | 32 |
| 100 Gbps* | 64 |
(* Estimated)
2022-10-21 08:35:27 -05:00
### Memory
* Mimumum RAM = 2 + (0.002 x Subscriber Count) GB
* Recommended RAM:
| Subscribers | RAM |
| ------------- | ------------- |
| 100 | 4 GB |
| 1,000 | 8 GB |
| 5,000 | 16 GB |
2022-10-22 17:49:12 -05:00
| 10,000* | 32 GB |
2022-11-17 16:09:16 -06:00
| 50,000* | 48 GB |
2022-10-22 17:49:12 -05:00
(* Estimated)
2022-10-21 08:35:27 -05:00
### Network Interface Requirements
2022-10-21 08:36:32 -05:00
* One management network interface completely separate from the traffic shaping interfaces. Usually this would be the Ethernet interface built in to the motherboard.
2022-10-21 08:35:27 -05:00
* Dedicated Network Interface Card for Shaping Interfaces
* NIC must have 2 or more interfaces for traffic shaping.
* NIC must have multiple TX/RX transmit queues. [Here's how to check from the command line](https://serverfault.com/questions/772380/how-to-tell-if-nic-has-multiqueue-enabled).
2022-09-09 21:02:01 -05:00
* Known supported cards:
2022-10-19 21:31:57 -05:00
* [NVIDIA Mellanox MCX512A-ACAT](https://www.fs.com/products/119649.html)
2022-09-09 21:02:01 -05:00
* [Intel X710](https://www.fs.com/products/75600.html)
* Intel X520
2022-09-10 19:37:08 -05:00
2022-09-11 14:30:40 -05:00
## Versions
2022-10-21 08:40:25 -05:00
### IPv4 + IPv6
2022-10-21 08:36:32 -05:00
- [v1.2.1-stable](https://github.com/rchac/LibreQoS/tree/main/v1.2)
2022-11-15 17:53:20 -06:00
- [Setup Guide](https://github.com/LibreQoE/LibreQoS/wiki/LibreQoS-v1.2-Installation-&-Usage-Guide-Physical-Server-and-Ubuntu-22.04)
2022-11-11 09:28:34 -06:00
- [v1.3-beta](https://github.com/rchac/LibreQoS/tree/main/v1.3)
2022-11-15 17:53:20 -06:00
- [Setup Guide](https://github.com/LibreQoE/LibreQoS/wiki/LibreQoS-v1.3-Installation-&-Usage-Guide-Physical-Server-and-Ubuntu-22.04)