How gravitl/netmaker works
Main System Components
a) Server Components (Core):
• Authentication Service (/auth)
• API Controllers (/controllers)
• Database Layer (/database)
• Message Queue System (/mq)
• Business Logic Layer (/logic)
• Server Configuration (/servercfg)
b) Client Components:
• Netclient (/netclient)
• CLI Interface (/cli)
c) External Integrations:
• DNS Management
• Authentication Providers (OAuth)
• MQTT Brokers (EMQX)
Architectural Patterns to Highlight
┌─ Client Layer ─────────────────────┐
• CLI Interface │
• Netclient │
• ┬────────────────┘
┌─ API Layer ──────▼────────────────┐
• REST Controllers │
• Authentication │
• Middleware │
• ┬────────────────┘
┌─ Business Layer ─▼────────────────┐
• Network Logic │
• Node Management │
• Access Control │
• User Management │
• ┬────────────────┘
┌─ Data Layer ─────▼────────────────┐
• Database (SQLite/PostgreSQL) │
• Message Queue │
• Configuration Store │
• ┘
Key Interactions
• Client-Server Communication (REST API)
• WireGuard Peer Connections
• Database Operations
• Message Queue Publishing/Subscribing
• DNS Updates
Deployment Context
Deployment options:
• Docker Container Deployment
• Kubernetes Deployment
• Cloud Provider Integration
• On-premises Installation
Additional Details
• Scalability points
• Security boundaries
• Data flow directions
• Component dependencies
• Extension points
Remember to:
• Clear boundaries between components
• Both control and data flows
• Security measures
• Monitoring points
This system design should reflect Netmaker's architecture as a WireGuard automation platform while showing both the open-source core and professional features in a clear, hierarchical structure.