Doc/12187 v2 add MODULES.md - a description of how modules work

[KEIAHNY]

PR Type

Documentation

---

Description

• Added comprehensive MODULES.md documentation file

• Documented Suriconf pipeline stages and workflow

• Explained all four configuration modules in detail

• Updated README.md with link to module documentation

---

Diagram Walkthrough

flowchart LR
  User["User provides config files"] --> Preconfig["Preconfiguration stage"]
  Preconfig --> Query["Query and Execute stage"]
  Query --> Output["suricata_result.yaml + nic_setup.sh"]

Loading

File Walkthrough

Relevant files

Documentation

MODULES.md Add comprehensive module and pipeline documentation            MODULES.md Created new documentation file with 272 lines Describes Suriconf pipeline stages (Preconfiguration, Query and Execute) Documents four modules: CPU affinity, Memory usage, Flow, Flow threads Includes formulas, responsibilities, and configuration details for each module +272/-0  README.md Link MODULES.md from README modules section                            README.md Updated modules section to reference MODULES.md Added link for detailed module descriptions +1/-1

---

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No major issues detected

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[KEIAHNY]

Closing: #13