IntenseWebs/LibreQoS
3
0 Fork 0
mirror of https://github.com/LibreQoE/LibreQoS.git synced 2026-10-25 06:17:39 -05:00
Code Issues Packages Projects Releases Wiki Activity

changes

Browse Source
This commit is contained in:
Robert Chacon committed 2026-03-17 09:04:12 -06:00
1 parent b42e1db722
commit f8c6852617
6 files changed
+72 -64
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs-es/v2.0/configuration-advanced-es.md
+5 -5
View File
@@ -254,15 +254,15 @@ A continuación un ejemplo de entrada en ShapedDevices.csv:
Si está utilizando una de nuestras integraciones con CRM, este archivo se generará automáticamente. Si no está utilizando una integración, puede editar el archivo manualmente usando la interfaz WebUI o editando directamente el archivo ShapedDevices.csv a través de la CLI.
#### TreeGuard y SQM por circuito (función próxima)
#### TreeGuard y SQM por circuito
TreeGuard es una función próxima de v2.0 que puede ajustar dinámicamente el SQM por circuito (`cake`/`fq_codel`) según condiciones del circuito.
TreeGuard puede ajustar dinámicamente el SQM por circuito (`cake`/`fq_codel`) según condiciones del circuito.
Importante:
- TreeGuard no está habilitado por defecto.
- El comportamiento por defecto de LibreQoS se mantiene en su SQM configurado/global a menos que habilite TreeGuard explícitamente.
- En LibreQoS v2.0, TreeGuard está habilitado por defecto.
- Si desea un comportamiento SQM fijo/manual, revise la configuración de TreeGuard temprano en el despliegue y ajuste su enrolamiento o deshabilítelo explícitamente.
Consulte [TreeGuard (Función Próxima de v2.0)](treeguard-es.md).
Consulte [TreeGuard](treeguard-es.md).
#### Múltiples IPs por Circuito
Si necesita listar múltiples IPv4 en el campo IPv4, o múltiples IPv6 en el campo IPv6, agregue una coma entre ellas. Si está editando con un editor CSV (LibreOffice Calc, Excel), el editor CSV automáticamente colocará comillas alrededor de los elementos separados por coma. Si usted está editando el archivo manualmente con un editor de texto como notepad o nano, por favor agregue comillas alrededor de las entradas separadas por coma.
docs-es/v2.0/htb_fq_codel_cake-es.md
+3 -3
View File
@@ -39,10 +39,10 @@ Cada clase HTB tiene un punto de acople para qdisc hijo. Si no hay qdisc hoja ex
Modelo práctico de comportamiento en LibreQoS:
1. La política por defecto de fábrica usa `HTB` + `cake diffserv4` para circuitos moldeados.
2. TreeGuard (función próxima) puede cambiar dinámicamente direcciones de circuito entre `cake diffserv4` y `fq_codel` según guardrails de baja carga/RTT.
3. TreeGuard no está habilitado por defecto.
2. TreeGuard puede cambiar dinámicamente direcciones de circuito entre `cake diffserv4` y `fq_codel` según guardrails de baja carga/RTT.
3. En LibreQoS v2.0, TreeGuard está habilitado por defecto y los operadores deberían revisar su enrolamiento y guardrails si desean comportamiento SQM fijo/manual.
Consulte [TreeGuard (Función Próxima de v2.0)](treeguard-es.md) para detalles de configuración y despliegue.
Consulte [TreeGuard](treeguard-es.md) para detalles de configuración y despliegue.
## 3) Resumen de HTB para Usuarios de AQM
docs-es/v2.0/treeguard-es.md
+28 -24
View File
@@ -1,12 +1,12 @@
# TreeGuard (Función Próxima de v2.0)
# TreeGuard
TreeGuard es una función próxima de LibreQoS v2.0 para gestión inteligente de nodos.
TreeGuard es una función actual de LibreQoS v2.0 para gestión inteligente de nodos.
Estado importante:
1. TreeGuard es **próximo**.
2. TreeGuard **no está habilitado por defecto**.
3. Los valores por defecto actuales no cambian a menos que un operador habilite TreeGuard explícitamente.
1. TreeGuard está **habilitado por defecto** en LibreQoS v2.0.
2. TreeGuard puede gestionar tanto la virtualización de nodos elegibles como la política SQM por circuito.
3. Los operadores pueden ajustar o deshabilitar TreeGuard en `/etc/lqos.conf` o en la página TreeGuard de la WebUI.
## Qué Hace TreeGuard
@@ -17,13 +17,15 @@ TreeGuard tiene dos dominios de control:
Para circuitos, TreeGuard puede tomar decisiones por dirección (descarga y subida de forma independiente).
## Comportamiento por Defecto sin TreeGuard
## Comportamiento por Defecto en LibreQoS v2.0
Cuando TreeGuard no está habilitado, LibreQoS mantiene la política SQM configurada/global (normalmente `cake diffserv4`, con overrides del operador cuando estén configurados).
En LibreQoS v2.0, TreeGuard está habilitado por defecto.
TreeGuard no afecta el tráfico si no está habilitado.
Por defecto, TreeGuard puede virtualizar nodos enrolados y puede cambiar direcciones de circuitos enrolados entre `cake diffserv4` y `fq_codel` según los guardrails configurados.
## Modelo de Conmutación SQM por Circuito (Cuando Está Habilitado)
Si prefiere un comportamiento fijo/manual, deshabilite TreeGuard o reduzca sus listas de enrolamiento.
## Modelo de Conmutación SQM por Circuito
TreeGuard evalúa utilización, frescura de RTT, guardrails de CPU y guardrails opcionales de QoO.
@@ -45,34 +47,36 @@ La configuración de TreeGuard vive bajo `[treeguard]` y sus sub-secciones:
4. `[treeguard.circuits]`: enrolamiento de circuitos y guardrails de conmutación SQM.
5. `[treeguard.qoo]`: umbral opcional de protección QoO.
Valores por defecto iniciales (PR #946):
Comportamiento por defecto actual:
```toml
[treeguard]
enabled = false
dry_run = true
enabled = true
dry_run = false
tick_seconds = 1
[treeguard.links]
enabled = true
all_nodes = true
top_level_auto_virtualize = true
[treeguard.circuits]
enabled = true
all_circuits = true
switching_enabled = true
independent_directions = true
idle_util_pct = 2.0
idle_min_minutes = 15
rtt_missing_seconds = 120
upgrade_util_pct = 5.0
min_switch_dwell_minutes = 30
max_switches_per_hour = 4
persist_sqm_overrides = true
[treeguard.qoo]
enabled = true
```
## Patrón de Despliegue Seguro
1. Mantenga `enabled = false` hasta revisar política y listas de enrolamiento.
2. Inicie con `enabled = true` y `dry_run = true`.
3. Use primero una allowlist pequeña de nodos/circuitos.
4. Valide el comportamiento en varias ventanas pico y valle.
5. Solo entonces establezca `dry_run = false`.
1. Revise la configuración de TreeGuard temprano en el despliegue en lugar de asumir comportamiento de colas fijo/manual.
2. Si desea un rollout más acotado, deshabilite `all_nodes` y/o `all_circuits` y utilice allowlists primero.
3. Valide el comportamiento en varias ventanas pico y valle.
4. Si quiere validar solo en modo observación, establezca `dry_run = true` temporalmente.
5. Si necesita comportamiento fijo/manual, establezca `enabled = false`.
## Overrides y Notas Operativas
docs/v2.0/configuration-advanced.md
+5 -5
View File
@@ -303,15 +303,15 @@ Examples:
If `sqm` is empty/missing, global queue defaults apply.
#### TreeGuard and per-circuit SQM (upcoming feature)
#### TreeGuard and per-circuit SQM
TreeGuard is an upcoming v2.0 feature that can dynamically adjust per-circuit SQM (`cake`/`fq_codel`) based on circuit conditions.
TreeGuard can dynamically adjust per-circuit SQM (`cake`/`fq_codel`) based on circuit conditions.
Important:
- TreeGuard is not enabled by default.
- Default LibreQoS behavior remains your configured/global SQM unless you explicitly enable TreeGuard.
- In LibreQoS v2.0, TreeGuard is enabled by default.
- If you want fixed/manual SQM behavior, review TreeGuard settings early in deployment and either narrow its enrollment or disable it explicitly.
See [TreeGuard (Upcoming v2.0 Feature)](treeguard.md).
See [TreeGuard](treeguard.md).
Here is an example of an entry in the ShapedDevices.csv file:
| Circuit ID | Circuit Name | Device ID | Device Name | Parent Node | MAC | IPv4 | IPv6 | Download Min Mbps | Upload Min Mbps | Download Max Mbps | Upload Max Mbps | Comment |
docs/v2.0/htb_fq_codel_cake.md
+3 -3
View File
@@ -39,10 +39,10 @@ Each HTB class has a child qdisc attachment point. If no explicit leaf qdisc is
Practical LibreQoS behavior model:
1. Default behavior uses `HTB` + `cake diffserv4` for shaped circuits.
2. TreeGuard (upcoming feature) can dynamically switch circuit directions between `cake diffserv4` and `fq_codel` based on low-load/RTT guardrails.
3. TreeGuard is not enabled by default.
2. TreeGuard can dynamically switch circuit directions between `cake diffserv4` and `fq_codel` based on low-load/RTT guardrails.
3. In LibreQoS v2.0, TreeGuard is enabled by default and operators should review its enrollment and guardrails if they want fixed/manual SQM behavior.
See [TreeGuard (Upcoming v2.0 Feature)](treeguard.md) for configuration and rollout details.
See [TreeGuard](treeguard.md) for configuration and rollout details.
## 3) HTB Summary for AQM Users
docs/v2.0/treeguard.md
+28 -24
View File
@@ -1,12 +1,12 @@
# TreeGuard (Upcoming v2.0 Feature)
# TreeGuard
TreeGuard is an upcoming LibreQoS v2.0 feature for intelligent node management.
TreeGuard is a current LibreQoS v2.0 feature for intelligent node management.
Important status:
1. TreeGuard is **upcoming**.
2. TreeGuard is **not enabled by default**.
3. Current defaults remain unchanged unless an operator explicitly enables TreeGuard.
1. TreeGuard is **enabled by default** in LibreQoS v2.0.
2. TreeGuard can manage both eligible node virtualization and per-circuit SQM policy.
3. Operators can tune or disable TreeGuard in `/etc/lqos.conf` or the WebUI TreeGuard page.
## What TreeGuard Does
@@ -17,13 +17,15 @@ TreeGuard has two control domains:
For circuits, TreeGuard can make per-direction decisions (download and upload independently).
## Default Behavior Without TreeGuard
## Default Behavior in LibreQoS v2.0
When TreeGuard is not enabled, LibreQoS behavior stays with configured/default SQM policy (commonly `cake diffserv4`, with operator overrides where configured).
In LibreQoS v2.0, TreeGuard is enabled by default.
TreeGuard does not affect traffic unless enabled.
By default, TreeGuard may virtualize enrolled nodes and may switch enrolled circuit directions between `cake diffserv4` and `fq_codel` according to its configured guardrails.
## Circuit SQM Switching Model (When Enabled)
If you prefer fixed/manual behavior, disable TreeGuard or narrow its enrollment lists.
## Circuit SQM Switching Model
TreeGuard evaluates utilization, RTT freshness, CPU guardrails, and optional QoO guardrails.
@@ -45,34 +47,36 @@ TreeGuard config lives under `[treeguard]` and sub-sections:
4. `[treeguard.circuits]`: circuit enrollment and SQM switching guardrails.
5. `[treeguard.qoo]`: optional QoO protection threshold.
From PR #946 defaults:
Current default behavior:
```toml
[treeguard]
enabled = false
dry_run = true
enabled = true
dry_run = false
tick_seconds = 1
[treeguard.links]
enabled = true
all_nodes = true
top_level_auto_virtualize = true
[treeguard.circuits]
enabled = true
all_circuits = true
switching_enabled = true
independent_directions = true
idle_util_pct = 2.0
idle_min_minutes = 15
rtt_missing_seconds = 120
upgrade_util_pct = 5.0
min_switch_dwell_minutes = 30
max_switches_per_hour = 4
persist_sqm_overrides = true
[treeguard.qoo]
enabled = true
```
## Safe Rollout Pattern
1. Keep `enabled = false` until you have reviewed policy and enrollment lists.
2. Start with `enabled = true` and `dry_run = true`.
3. Use a small allowlist of nodes/circuits first.
4. Validate behavior over multiple peak/off-peak windows.
5. Only then set `dry_run = false`.
1. Review TreeGuard settings early in deployment instead of assuming static/manual queue behavior.
2. If you want a narrower rollout, disable `all_nodes` and/or `all_circuits` and use allowlists first.
3. Validate behavior over multiple peak/off-peak windows.
4. If you want observation-only validation, set `dry_run = true` temporarily.
5. If you need fixed/manual behavior, set `enabled = false`.
## Overrides and Operational Notes