Merge remote-tracking branch 'origin/lts2_client' into lts2_client

LibreQoE · Nov 14, 2024 · 86931e3 · 86931e3
2 parents fd9af3b + f2a0b1e
commit 86931e3
Show file tree

Hide file tree

Showing 14 changed files with 59 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,18 @@
 <a href="https://libreqos.io/"><img alt="LibreQoS" src="https://user-images.githubusercontent.com/22501920/202913614-4ff2e506-e645-4a94-9918-d512905ab290.png"></a>
 
-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.
+LibreQoS is software used by Internet Service Providers (ISPs) and companies to improve the Quality of Experience (QoE) of end-users on their networks. 
 
-Servers running LibreQoS can shape traffic for thousands of customers. On higher-end servers, LibreQoS is capable of shaping 50-80 Gbps of traffic.
+LibreQoS works by monitoring network performance and reducing latency for interactive online applications. ISPs regularly report that trouble calls reduce substantially after deploying LibreQoS on networks.
 
-Learn more at [LibreQoS.io](https://libreqos.io/)!
+For an ISP or other company to deploy LibreQoS – no changes are required for existing Routers, Switches or Access points: LibreQoS runs on a server that acts as a managed bridge sitting between the edge router and the core of the network. LibreQoS servers can shape traffic for tens of thousands of customers.
+
+LibreQoS benefits network operation and planning by measuring metrics such as end-to-end TCP round trip time for each Subscriber, Access Point, and Site on a network – saving the relevant data for later analysis on the LibreQoS Long Term Stats (LTS) system.
+
+LibreQoS code is Open Source. It improves Quality of Experience by implementing state of the art Flow Queueing (FQ) and Active Queue Management (AQM) algorithms. LibreQoS offers paid support packages and subscriptions to additional analysis service features available through [LTS](https://libreqos.io/lts/).
+
+
+
+To learn more, please visit [LibreQoS.io](https://libreqos.io/).
 
 <img alt="LibreQoS" src="https://user-images.githubusercontent.com/22501920/223866474-603e1112-e2e6-4c67-93e4-44c17b1b7c43.png"></a>
 
@@ -38,11 +46,9 @@ Our Zulip chat server is available at [https://chat.libreqos.io/join/fvu3cerayya
 
 ## Long-Term Stats (LTS)
 
-Long-Term Stats (LTS) is an analytics service built for LibreQoS that revolutionizes the way you track and analyze your network.
-With flexible time window views ranging from 5 minutes to 1 month, LTS gives you comprehensive insights into your network's performance.
-Built from the ground-up for performance and efficiency, LTS greatly outperforms our original InfluxDB plugin, and gives you rapidly rendered data to help you maximize your network performance.
+LibreQoS Long-Term Stats (LTS) is an analytics service that overhauls the way you track and analyze your network. With flexible time window views ranging from 5 minutes to 1 month, LTS gives you  comprehensive insights into your network’s performance. Built from the ground-up for performance and efficiency, LTS greatly outperforms other solutions, and gives you rapidly rendered data to help you maximize your network performance.
 
-We provide a free 30-day trial of LTS, after which the rate is $0.30 USD per shaped subscriber.
+We provide a free 30-day trial of LTS, after which the rate is $0.30 USD per shaped subscriber per month.
 You can enroll in the 30-day free trial by [upgrading to the latest version of LibreQoS v1.4](https://libreqos.readthedocs.io/en/latest/docs/Updates/update.html) and selecting "Start Stats Free Trial" in the top-right corner of the local LibreQoS WebUI.
 
 <img alt="LibreQoS Long Term Stats" src="https://i0.wp.com/libreqos.io/wp-content/uploads/2023/11/01-Dashboard.png"></a>

diff --git a/docs/SystemRequirements/Compute.md b/docs/SystemRequirements/Compute.md
@@ -7,49 +7,56 @@
 * 2 or more CPU cores
 * A CPU with solid [single-thread performance](https://www.cpubenchmark.net/singleThread.html#server-thread) within your budget. Queuing is very CPU-intensive, and requires high single-thread performance.
 
-Single-thread CPU performance will determine the max throughput of a single HTB (cpu core), and in turn, what max speed plan you can offer customers.
+Single-thread CPU performance will determine the maximum capacity of a single HTB (cpu core), and in turn, the maximum capacity of any top level node in the network hierarchy (for example, top-level sites in your network). This also impacts the maximum speed plan you can offer customers within safe margins.
 
-| Customer Max Plan   | Passmark Single-Thread   |
+| Top Level Node Max  | Single-Thread Score      |
+| --------------------| ------------------------ |
+| 1 Gbps              | 1000                     |
+| 2 Gbps              | 1500                     |
+| 3 Gbps              | 2000                     |
+| 5 Gbps              | 4000                     |
+
+| Customer Max Plan   | Single-Thread Score      |
 | --------------------| ------------------------ |
 | 100 Mbps            | 1000                     |
 | 250 Mbps            | 1250                     |
 | 500 Mbps            | 1500                     |
-| 1 Gbps              | 2000                     |
-| 2.5 Gbps            | 3000                     |
+| 1 Gbps              | 1750                     |
+| 2.5 Gbps            | 2000                     |
 | 5 Gbps              | 4000                     |
 
-Below is a table of approximate aggregate throughput capacity, assuming a a CPU with a [single thread](https://www.cpubenchmark.net/singleThread.html#server-thread) performance of 2700 / 4000:
-
-| Aggregate Throughput    | CPU Cores Needed (>2700 single-thread) | CPU Cores Needed (>4000 single-thread) |
-| ------------------------| -------------------------------------- | -------------------------------------- |
-| 500 Mbps                | 2                                      | 2                                      |
-| 1 Gbps                  | 4                                      | 2                                      |
-| 5 Gbps                  | 6                                      | 4                                      |
-| 10 Gbps                 | 8                                      | 6                                      |
-| 20 Gbps                 | 16                                     | 8                                      |
-| 50 Gbps                 | 32                                     | 16                                     |
-| 100 Gbps                | 64                                     | 32                                     |
+Below is a table of approximate aggregate capacity, assuming a a CPU with a [single thread](https://www.cpubenchmark.net/singleThread.html#server-thread) performance of 1000 / 2000 / 4000:
 
-So for example, an ISP delivering 1Gbps service plans with 10Gbps aggregate throughput would choose a CPU with a 2500+ single-thread score and 8 cores, such as the Intel Xeon E-2388G @ 3.20GHz.
+| CPU Cores | Single-Thread Score = 1000 | Single-Thread Score = 2000 | Single-Thread Score = 4000 |
+|-----------|----------------------------|----------------------------|----------------------------|
+| 2         | 1 Gbps                     | 3 Gbps                     | 7 Gbps                     |
+| 4         | 3 Gbps                     | 5 Gbps                     | 13 Gbps                    |
+| 6         | 4 Gbps                     | 8 Gbps                     | 20 Gbps                    |
+| 8         | 5 Gbps                     | 10 Gbps                    | 27 Gbps                    |
+| 16        | 10 Gbps                    | 21 Gbps                    | 54 Gbps                    |
+| 32        | 21 Gbps                    | 42 Gbps                    | 108 Gbps                   |
+| 64        | 42 Gbps                    | 83 Gbps                    | 216 Gbps                   |
 
 ### Memory
 * Recommended RAM:
 
 | Subscribers   | RAM           |
 | ------------- | ------------- |
-| 100           | 8 GB          |
-| 1,000         | 16 GB         |
+| 500           | 16 GB         |
+| 1,000         | 32 GB         |
 | 5,000         | 64 GB         |
 | 10,000        | 128 GB        |
 | 20,000        | 256 GB        |
 
 ### Server Recommendations
 Here are some convenient, off-the-shelf server options to consider:
-| Throughput   | Model | CPU Option | RAM Option | NIC Option | Extras | Temp Range |
-| --- | --- | --- | --- | --- | --- | --- | 
-| 2.5 Gbps | [Supermicro SYS-E102-13R-E](https://store.supermicro.com/us_en/compact-embedded-iot-i5-1350pe-sys-e102-13r-e.html) | Default | 2x8GB | Built-in | [USB-C RJ45](https://www.amazon.com/Anker-Ethernet-PowerExpand-Aluminum-Portable/dp/B08CK9X9Z8/)| 0°C ~ 40°C (32°F ~ 104°F) |
-| 10 Gbps | [Supermicro AS -1115S-FWTRT](https://store.supermicro.com/us_en/1u-amd-epyc-8004-compact-server-as-1115s-fwtrt.html) | 8124P | 2x16GB | Mellanox (2 x SFP28) | | 0°C ~ 40°C (32°F ~ 104°F) |
-| 25 Gbps | [Supermicro AS -1115S-FWTRT](https://store.supermicro.com/us_en/1u-amd-epyc-8004-compact-server-as-1115s-fwtrt.html) | 8534P | 4x16GB | Mellanox (2 x SFP28) | | 0°C ~ 40°C (32°F ~ 104°F) |
+| Throughput | Per Node / Per CPU Core| Model | CPU Option | RAM Option | NIC Option | Extras | Temp Range |
+| --- | --- | --- | --- | --- | --- | --- | --- | 
+| 2.5 Gbps | 1 Gbps | [Supermicro SYS-E102-13R-E](https://store.supermicro.com/us_en/compact-embedded-iot-i5-1350pe-sys-e102-13r-e.html) | Default | 2x8GB | Built-in | [USB-C RJ45](https://www.amazon.com/Anker-Ethernet-PowerExpand-Aluminum-Portable/dp/B08CK9X9Z8/)| 0°C ~ 40°C (32°F ~ 104°F) |
+| 10 Gbps | 3 Gbps | [Supermicro AS-1115S-FWTRT](https://store.supermicro.com/us_en/1u-amd-epyc-8004-compact-server-as-1115s-fwtrt.html) | 8124P | 2x16GB | Mellanox (2 x SFP28) | | 0°C ~ 40°C (32°F ~ 104°F) |
+| 10 Gbps | 5 Gbps | [Supermicro SYS-511R-M](https://store.supermicro.com/us_en/mainstream-1u-sys-511r-m.html) | E-2488 | 2x32GB | 10-Gigabit X710-BM2 (2 x SFP+) | | 0°C ~ 40°C (32°F ~ 104°F) |
+| 10 Gbps | 5 Gbps | [Dell PowerEdge R260](https://www.dell.com/en-us/shop/dell-poweredge-servers/new-poweredge-r260-rack-server/spd/poweredge-r260/pe_r260_tm_vi_vp_sb?configurationid=2cd33e43-57a3-4f82-aa72-9d5f45c9e24c) | E-2456 | 2x32GB | Intel X710-T2L (2 x 10G RJ45) | | 5–40°C (41–104°F) |
+| 25 Gbps |  3 Gbps | [Supermicro AS-1115S-FWTRT](https://store.supermicro.com/us_en/1u-amd-epyc-8004-compact-server-as-1115s-fwtrt.html) | 8534P | 4x16GB | Mellanox (2 x SFP28) | | 0°C ~ 40°C (32°F ~ 104°F) |
 
 ### 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.

diff --git a/docs/v1.5/Quickstart/configuration.md → docs/v2.0/Quickstart/configuration.md b/docs/v1.5/Quickstart/configuration.md → docs/v2.0/Quickstart/configuration.md
diff --git a/...1.5/Quickstart/quickstart-libreqos-1.5.md → ...2.0/Quickstart/quickstart-libreqos-2.0.md b/...1.5/Quickstart/quickstart-libreqos-1.5.md → ...2.0/Quickstart/quickstart-libreqos-2.0.md
@@ -1,4 +1,4 @@
-# Install LibreQoS 1.5
+# Install LibreQoS 2.0
 
 ## Step 1 - Validate Network Design Assumptions and Hardware Selection
 
@@ -17,7 +17,7 @@ Donwload the latest .deb from [libreqos.io/#download](https://libreqos.io/#downl
 
 Unzip the .zip file and transfer the .deb to your LibreQoS box, installing with:
 ```
-sudo apt install [deb file name]
+sudo apt install ./deb_file_name.deb
 ```
 
 ### Git Install (For Developers Only - Not Recommended)

diff --git a/docs/v1.5/Quickstart/quickstart-prereq.md → docs/v2.0/Quickstart/quickstart-prereq.md b/docs/v1.5/Quickstart/quickstart-prereq.md → docs/v2.0/Quickstart/quickstart-prereq.md
diff --git a/docs/v1.5/Quickstart/services-and-run.md → docs/v2.0/Quickstart/services-and-run.md b/docs/v1.5/Quickstart/services-and-run.md → docs/v2.0/Quickstart/services-and-run.md
diff --git a/docs/v1.5/Quickstart/share.md → docs/v2.0/Quickstart/share.md b/docs/v1.5/Quickstart/share.md → docs/v2.0/Quickstart/share.md
diff --git a/docs/v1.5/TechnicalDocs/extras.md → docs/v2.0/TechnicalDocs/extras.md b/docs/v1.5/TechnicalDocs/extras.md → docs/v2.0/TechnicalDocs/extras.md
diff --git a/docs/v1.5/TechnicalDocs/git-install.md → docs/v2.0/TechnicalDocs/git-install.md b/docs/v1.5/TechnicalDocs/git-install.md → docs/v2.0/TechnicalDocs/git-install.md
diff --git a/docs/v1.5/TechnicalDocs/integrations.md → docs/v2.0/TechnicalDocs/integrations.md b/docs/v1.5/TechnicalDocs/integrations.md → docs/v2.0/TechnicalDocs/integrations.md
diff --git a/.../v1.5/TechnicalDocs/performance-tuning.md → .../v2.0/TechnicalDocs/performance-tuning.md b/.../v1.5/TechnicalDocs/performance-tuning.md → .../v2.0/TechnicalDocs/performance-tuning.md
diff --git a/docs/v1.5/TechnicalDocs/troubleshooting.md → docs/v2.0/TechnicalDocs/troubleshooting.md b/docs/v1.5/TechnicalDocs/troubleshooting.md → docs/v2.0/TechnicalDocs/troubleshooting.md
diff --git a/docs/v1.5/Updates/update.md → docs/v2.0/Updates/update.md b/docs/v1.5/Updates/update.md → docs/v2.0/Updates/update.md
@@ -1,4 +1,4 @@
-# Updating 1.5 To Latest Version
+# Updating To The Latest Version
 
 ```{warning}
 If you use the XDP bridge, traffic will briefly stop passing through the bridge when lqosd restarts (XDP bridge is only operating while lqosd runs).
@@ -10,7 +10,7 @@ Donwload the latest .deb from [libreqos.io/#download](https://libreqos.io/#downl
 
 Unzip the .zip file and transfer the .deb to your LibreQoS box, installing with:
 ```
-sudo apt install [deb file name]
+sudo apt install ./[deb file name]
 ```
 
 Now run:

diff --git a/index.rst b/index.rst
@@ -45,25 +45,18 @@ Welcome to the LibreQoS documentation!
 
 .. toctree::
    :maxdepth: 1
-   :caption: v1.5:
+   :caption: v2.0:
 
-   docs/v1.5/Quickstart/quickstart-libreqos-1.5
-   docs/v1.5/Quickstart/quickstart-prereq
-   docs/v1.5/Quickstart/configuration
-   docs/v1.5/Quickstart/services-and-run
-   docs/v1.5/Quickstart/share
+   docs/v2.0/Quickstart/quickstart-libreqos-2.0
+   docs/v2.0/Quickstart/quickstart-prereq
+   docs/v2.0/Quickstart/configuration
+   docs/v2.0/Quickstart/services-and-run
+   docs/v2.0/Quickstart/share
 
-   docs/v1.5/Updates/update
-
-   docs/v1.5/TechnicalDocs/complex-install
-   docs/v1.5/TechnicalDocs/troubleshooting
-   docs/v1.5/TechnicalDocs/integrations
-   docs/v1.5/TechnicalDocs/extras
-   docs/v1.5/TechnicalDocs/performance-tuning
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Legacy:
-
-   docs/Legacy/v1.3.1
+   docs/v2.0/Updates/update
 
+   docs/v2.0/TechnicalDocs/complex-install
+   docs/v2.0/TechnicalDocs/troubleshooting
+   docs/v2.0/TechnicalDocs/integrations
+   docs/v2.0/TechnicalDocs/extras
+   docs/v2.0/TechnicalDocs/performance-tuning