How community-vyprojects/vymanager works
VyManager is a multi-tenant VyOS control plane. Users authenticate in the web app, choose a managed router, then configure features through the API; the backend checks access, resolves a session-specific VyOS service, translates version-aware operations, and sends them to the router. The README also describes dashboards, RBAC and multi-version support. The graph includes these documented capabilities, but source excerpts are incomplete, so unverified frontend/API and monitoring links are shown as dashed.
Main entry points: app.py API application · fastapi_permissions.py Permission checks · traffic_engineering.py Traffic engineering · routers Feature endpoints
Components 23
Web interface
- Management UI
frontend/src - Feature forms
frontend/src/components - Frontend API
frontend/src/lib/api - Live dashboards
frontend/src
Identity and access
- Authentication
backend/middleware/auth.py - Session middleware
backend/middleware/session.py - Permission checks
backend/fastapi_permissions.py - RBAC rules
backend/rbac_permissions.py
Configuration API
- API application
backend/app.py - Feature endpoints
backend/routers - Traffic engineering
backend/routers/traffic_engineering/traffic_engineering.py - Static routes
backend/routers/static_routes/static_routes.py - Batch dispatch
backend/batch_dispatch.py - Session VyOS service
backend/session_vyos_service.py - Event manager
backend/events/event_manager.py
VyOS translation
- Feature builders
backend/vyos_builders - TE batch builder
backend/vyos_builders/traffic_engineering/traffic_engineering_batch_builder.py - Mapper registry
backend/vyos_mappers/base.py - Version mappers
backend/vyos_mappers - VyOS service
backend/vyos_service.py
Other components
- Operator
- VyOS router
- PostgreSQL
Connections 25
- Operator → Management UI: uses
README.md - Management UI → Feature forms: renders
frontend/src/components/traffic-engineering/TrafficEngineeringContent.tsx - Feature forms → Frontend API: requests
- Frontend API → API application: calls API
- API application → Authentication: installs
backend/app.py - API application → Session middleware: installs
backend/app.py - API application → Feature endpoints: registers
backend/app.py - Authentication → Session middleware: sets identity
backend/middleware/auth.py - Session middleware → Permission checks: sets request context
backend/fastapi_permissions.py - Permission checks → RBAC rules: checks roles
backend/fastapi_permissions.py - Feature endpoints → Permission checks: guards endpoints
backend/routers/access_list/access_list.py - Traffic engineering → Permission checks: checks access
backend/routers/traffic_engineering/traffic_engineering.py - Traffic engineering → Session VyOS service: resolves service
backend/routers/traffic_engineering/traffic_engineering.py - Static routes → Session VyOS service: resolves service
backend/routers/static_routes/static_routes.py - Feature endpoints → Batch dispatch: resolves operations
backend/routers/access_list/access_list.py - Traffic engineering → TE batch builder: builds commands
backend/routers/traffic_engineering/traffic_engineering.py - TE batch builder → Mapper registry: gets mapper
backend/vyos_builders/traffic_engineering/traffic_engineering_batch_builder.py - Feature builders → Mapper registry: uses registry
- Mapper registry → Version mappers: registers versions
backend/vyos_mappers/__init__.py - Session VyOS service → VyOS service: creates service
backend/session_vyos_service.py - Traffic engineering → VyOS service: executes batch
backend/routers/traffic_engineering/traffic_engineering.py - VyOS service → VyOS router: configures router
- Permission checks → PostgreSQL: reads permissions
backend/fastapi_permissions.py - Live dashboards → VyOS router: reads live data
README.md - API application → Event manager: registers routes