How alef-burzmali/netbox-data-flows works
File structure
• Top-level:
• Configuration & CI: .github/, mkdocs.yml, pre-commit, pyproject.toml
• Docs: docs/ + mkdocs site
• Plugin code: netbox_data_flows/
• Plugin package subfolders:
• api/ – DRF serializers, URL router, views
• models/ – Django models (Application, DataFlow, Group, ObjectAlias, ApplicationRole)
• migrations/ – schema changes
• forms/, filtersets/, tables/ – UI forms, filter backends, table definitions
• views/ – Django views to render plugin pages & tab views
• templates/ – HTML Jinja2 templates under netbox_data_flows/
• utils/, navigation.py, search.py – helpers, NetBox navigation/menu registration, custom search support
• Integration points: netbox_data_flows/navigation.py registers new menu items; netbox_data_flows/urls.py included by NetBox router; serializers used by NetBox’s REST API.
README for additional insights
• Purpose: document and group data flows to assist network design, firewall automation, security compliance.
• Links to data model docs (to get entity relationship details).
• Features: UI tabs on Devices, VMs, IPs; Data flow detail pages; Application grouping; hierarchical groups.
Elements
• Clear labels: “NetBox Core”, “Data Flows Plugin”, “PostgreSQL DB”, “Browser”, “API Client”.
• Plugin components in another (e.g., light green)
• External consumers (browser, automation) in a third (e.g., gray)
Additional detail on plugin models to capture
• DataFlow: source object(s) → destination object(s), ports, protocol
• Application: groups multiple DataFlows + optional NetBox object assignments
• Hierarchical grouping of DataFlows or Applications
• ObjectAlias: named references for complex NetBox objects sets
• ApplicationRole: custom roles linking Applications to devices or users