How syklonak/ng-control-plane works
pg-router is a configuration-driven Nginx control plane, not a traffic proxy. Its principal workflow loads and validates a declarative routing topology, resolves its backend and tunnel endpoints, generates Nginx fragments, then tests and deploys them; Nginx serves production traffic. The graph also includes configuration authoring and management, status and health, rollback, and Nginx installation/operations. Some internal relationships are supported by the source index rather than inspected implementation; those edges cite the caller file or README as available evidence.
Main entry points: services.py Command services · deployer.py Atomic deployer · validator.py Config validator · generator.py Nginx generator
Components 23
User interface
- CLI
pg_router/cli/app.py - Interactive menu
pg_router/cli/menu.py - Config wizard
pg_router/cli/wizard.py - Command services
pg_router/services/services.py
Configuration
- Config management
pg_router/config/management.py - Config loader
pg_router/config/loader.py - Config schema
pg_router/config/schema.py - Config validator
pg_router/config/validator.py
Routing model
- Topology resolver
pg_router/model/topology.py - Route selection
pg_router/model/selection.py - Route matcher
pg_router/model/matcher.py - Capabilities
pg_router/model/capabilities.py - Provider adapters
pg_router/plugins/providers.py - Provider registry
pg_router/plugins/registry.py
Nginx operations
- Nginx generator
pg_router/nginx/generator.py - Atomic deployer
pg_router/deploy/deployer.py - Health checks
pg_router/deploy/health.py - Nginx manager
pg_router/nginx/manager.py - Nginx installer
pg_router/nginx/installer.py - Module detection
pg_router/nginx/modules.py
Other components
- Operator
- Routing config
- Nginx
Connections 36
- Operator → CLI: invokes
README.md - CLI → Interactive menu: opens
pg_router/cli/app.py - CLI → Config wizard: launches
pg_router/cli/app.py - CLI → Command services: delegates
pg_router/cli/app.py - Command services → Config management: manages files
pg_router/services/services.py - Operator → Routing config: authors
README.md - Config wizard → Routing config: creates
README.md - Config management → Routing config: reads and edits
README.md - Command services → Config loader: loads
pg_router/services/services.py - Config loader → Config schema: parses into
pg_router/config/loader.py - Config validator → Config schema: checks objects
pg_router/config/validator.py - Command services → Config validator: validates
pg_router/services/services.py - Config validator → Route selection: compiles routes
pg_router/config/validator.py - Config validator → Capabilities: checks compatibility
pg_router/config/validator.py - Command services → Topology resolver: resolves endpoints
pg_router/services/services.py - Topology resolver → Provider registry: resolves providers
pg_router/model/topology.py - Command services → Route matcher: simulates routes
pg_router/services/services.py - Nginx generator → Topology resolver: consumes resolved routes
pg_router/nginx/generator.py - Nginx generator → Route selection: uses selections
pg_router/nginx/generator.py - Nginx generator → Provider registry: resolves certificates
pg_router/nginx/generator.py - Provider adapters → Provider registry: registers adapters
pg_router/plugins/providers.py - Command services → Nginx generator: generates fragments
pg_router/services/services.py - Atomic deployer → Config validator: validates config
pg_router/deploy/deployer.py - Atomic deployer → Topology resolver: resolves topology
pg_router/deploy/deployer.py - Atomic deployer → Nginx generator: generates fragments
pg_router/deploy/deployer.py - Atomic deployer → Nginx manager: tests and reloads
pg_router/deploy/deployer.py - Command services → Atomic deployer: applies changes
pg_router/services/services.py - Command services → Health checks: checks health
pg_router/services/services.py - Health checks → Provider registry: uses probe providers
pg_router/deploy/health.py - Command services → Nginx manager: runs operations
pg_router/services/services.py - Nginx installer → Module detection: detects modules
pg_router/nginx/installer.py - Nginx installer → Nginx manager: configures Nginx
pg_router/nginx/installer.py - Nginx manager → Module detection: detects capabilities
pg_router/nginx/manager.py - Nginx manager → Nginx: tests and controls
pg_router/nginx/manager.py - Nginx installer → Nginx: installs packages
README.md - Nginx → Operator: serves traffic
README.md