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

[KEIAHNY]

PR Type

Documentation

---

Description

• Added comprehensive MODULES.md documentation file

• Documented Suriconf pipeline stages with diagrams

• Detailed all 4 configuration modules with formulas

• Updated README.md with MODULES.md reference link

---

Diagram Walkthrough

flowchart LR
  User["User provides config"] --> 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 Suriconf modules documentation                  MODULES.md Created new documentation file with 272 lines Documented Suriconf pipeline with 2 stages diagram Detailed CPU affinity, Memory usage, Flow, Flow threads modules Included calculation formulas and configuration parameters +272/-0  README.md Link MODULES.md from README modules section                            README.md Added reference link to MODULES.md in modules section Improved navigation to detailed module descriptions +1/-1

---

[KEIAHNY]

/review

[github-actions]

PR Reviewer Guide 🔍

(Review updated until commit f47c73a)

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

[KEIAHNY]

/review

[github-actions]

Persistent review updated to latest commit f47c73a

[KEIAHNY]

/review

[github-actions]

Persistent review updated to latest commit f47c73a

[KEIAHNY]

Closing: #12.