How richardpateau/network-automation-engine works
This is a network automation and compliance engine: it obtains device inventory and desired configuration from NetBox, processes devices concurrently, collects live state over supported transports, checks drift, remediates it, validates changes, and reports results. The graph shows the documented end-to-end stages and the sampled control flow. Many feature modules are unsampled, so their internal calls and exact orchestration links are intentionally not asserted; the oddly spaced remediation paths are preserved as listed in the tree.
Main entry points: manager.py Concurrent Processing · main.py Application Entry · runner.py Pipeline Runner · compliance.py STP Compliance
Components 20
Orchestration
- Application Entry
src/main.py - Concurrent Processing
src/process/manager.py - Pipeline Runner
src/pipeline/runner.py - Feature Resolver
src/pipeline/resolver.py
Desired State
- NetBox Inventory
src/sot/inventory.py - NetBox API Client
src/sot/client.py
Device Automation
- Device Sessions
src/transports/session_manager.py - CLI Collection
src/collectors/cli/builders.py - NETCONF Collection
src/collectors/netconf/builders.py - RESTCONF Collection
src/collectors/restconf/builders.py
Compliance and Remediation
- Compliance Checks
src/compliance - STP Compliance
src/compliance/switching/stp/compliance.py - Configuration Remediation
src/remediation - STP Remediation
src/remediation/switching /stp.py - NAT Remediation
src/remediation/routing/nat.py - Template Environment
src/remediation/template_env.py
Reporting
- Compliance Reports
src/reporting
Other components
- Operator
- Managed Devices
- NetBox
Connections 21
- Operator → Application Entry: starts run
- Application Entry → NetBox Inventory: loads desired state
- NetBox Inventory → NetBox API Client: requests API
src/sot/inventory.py - NetBox API Client → NetBox: queries inventory
src/sot/client.py - Application Entry → Concurrent Processing: submits device tasks
src/main.py - Concurrent Processing → Device Sessions: opens session
src/process/manager.py - Concurrent Processing → CLI Collection: collects CLI state
src/process/manager.py - Concurrent Processing → NETCONF Collection: collects NETCONF state
src/process/manager.py - Concurrent Processing → RESTCONF Collection: collects RESTCONF state
src/process/manager.py - Concurrent Processing → Pipeline Runner: runs pipeline
src/process/manager.py - Pipeline Runner → Feature Resolver: uses resolver
src/pipeline/runner.py - Pipeline Runner → Compliance Checks: evaluates features
- Compliance Checks → Configuration Remediation: remediates drift
- STP Compliance → STP Remediation: configures STP
src/compliance/switching/stp/compliance.py - STP Remediation → Template Environment: renders templates
src/remediation/switching /stp.py - NAT Remediation → Template Environment: renders templates
src/remediation/routing/nat.py - STP Compliance → CLI Collection: recollects state
src/compliance/switching/stp/compliance.py - Concurrent Processing → Compliance Reports: records device results
- Application Entry → Compliance Reports: generates reports
- Device Sessions → Managed Devices: connects to devices
- Configuration Remediation → Managed Devices: changes configuration