Files
LibreQoS/docs/v2.0/operating-modes.md
T
2026-02-25 18:50:54 -07:00

1.3 KiB

Operating Modes and Source of Truth

LibreQoS supports two first-class operating modes.

In this mode, your CRM/NMS is the source of truth and LibreQoS integration jobs produce shaping inputs.

Key behavior:

  • ShapedDevices.csv is regenerated by integration sync cycles.
  • network.json overwrite behavior depends on integration settings (for example always_overwrite_network_json).
  • Direct manual edits may be overwritten on the next scheduler refresh.

Custom Source-of-Truth

In this mode, your own scripts/systems generate network.json and ShapedDevices.csv.

Key behavior:

  • Your external workflow owns persistence.
  • WebUI edits are valid for quick operational changes.
  • Permanent changes should be made in your external source-of-truth workflow.

Mode Declaration Checklist (Before Go-Live)

  1. Pick one primary source of truth.
  2. Confirm which system can write production shaping inputs.
  3. Confirm scheduler refresh behavior and overwrite cadence.
  4. Document your hotfix workflow (WebUI, external editor, or both).
  5. Do not maintain competing edits in multiple systems for the same objects.