# community-vyprojects/vymanager architecture

> Architecture diagram of the GitHub repository community-vyprojects/vymanager, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/community-vyprojects/vymanager
- Repository: https://github.com/community-vyprojects/vymanager

## Overview

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: [`backend/app.py`](https://github.com/community-vyprojects/vymanager/blob/beta/backend/app.py) (API application), [`backend/fastapi_permissions.py`](https://github.com/community-vyprojects/vymanager/blob/beta/backend/fastapi_permissions.py) (Permission checks), [`backend/routers/traffic_engineering/traffic_engineering.py`](https://github.com/community-vyprojects/vymanager/blob/beta/backend/routers/traffic_engineering/traffic_engineering.py) (Traffic engineering), [`backend/routers`](https://github.com/community-vyprojects/vymanager/tree/beta/backend/routers) (Feature endpoints)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web interface"]
  node_frontend["Management UI"]
  node_feature_ui["Feature forms"]
  node_api_client["Frontend API"]
  node_dashboards["Live dashboards"]
end

subgraph group_identity["Identity and access"]
  node_auth["Authentication<br/>[auth.py]"]
  node_session["Session middleware<br/>[session.py]"]
  node_permissions["Permission checks"]
  node_rbac["RBAC rules"]
end

subgraph group_api["Configuration API"]
  node_app["API application<br/>[app.py]"]
  node_routers["Feature endpoints"]
  node_te_router["Traffic engineering"]
  node_static_router["Static routes<br/>[static_routes.py]"]
  node_dispatch["Batch dispatch<br/>[batch_dispatch.py]"]
  node_session_service["Session VyOS service"]
  node_events["Event manager<br/>[event_manager.py]"]
end

subgraph group_translation["VyOS translation"]
  node_builders["Feature builders"]
  node_te_builder["TE batch builder"]
  node_mapper_registry["Mapper registry<br/>[base.py]"]
  node_mappers["Version mappers"]
  node_vyos_service["VyOS service<br/>[vyos_service.py]"]
end

node_user(("Operator"))
node_router{{"VyOS router"}}
node_postgres[("PostgreSQL")]

node_user -->|"uses"| node_frontend
node_frontend -.->|"renders"| node_feature_ui
node_feature_ui -.->|"requests"| node_api_client
node_api_client -.->|"calls API"| node_app
node_app -->|"installs"| node_auth
node_app -->|"installs"| node_session
node_app -->|"registers"| node_routers
node_auth -->|"sets identity"| node_session
node_session -->|"sets request context"| node_permissions
node_permissions -->|"checks roles"| node_rbac
node_routers -->|"guards endpoints"| node_permissions
node_te_router -->|"checks access"| node_permissions
node_te_router -->|"resolves service"| node_session_service
node_static_router -->|"resolves service"| node_session_service
node_routers -->|"resolves operations"| node_dispatch
node_te_router -->|"builds commands"| node_te_builder
node_te_builder -->|"gets mapper"| node_mapper_registry
node_builders -.->|"uses registry"| node_mapper_registry
node_mapper_registry -->|"registers versions"| node_mappers
node_session_service -->|"creates service"| node_vyos_service
node_te_router -->|"executes batch"| node_vyos_service
node_vyos_service -.->|"configures router"| node_router
node_permissions -->|"reads permissions"| node_postgres
node_dashboards -.->|"reads live data"| node_router
node_app -.->|"registers routes"| node_events

click node_frontend "https://github.com/community-vyprojects/vymanager/tree/beta/frontend/src"
click node_feature_ui "https://github.com/community-vyprojects/vymanager/tree/beta/frontend/src/components"
click node_api_client "https://github.com/community-vyprojects/vymanager/tree/beta/frontend/src/lib/api"
click node_auth "https://github.com/community-vyprojects/vymanager/blob/beta/backend/middleware/auth.py"
click node_session "https://github.com/community-vyprojects/vymanager/blob/beta/backend/middleware/session.py"
click node_permissions "https://github.com/community-vyprojects/vymanager/blob/beta/backend/fastapi_permissions.py"
click node_rbac "https://github.com/community-vyprojects/vymanager/blob/beta/backend/rbac_permissions.py"
click node_app "https://github.com/community-vyprojects/vymanager/blob/beta/backend/app.py"
click node_routers "https://github.com/community-vyprojects/vymanager/tree/beta/backend/routers"
click node_te_router "https://github.com/community-vyprojects/vymanager/blob/beta/backend/routers/traffic_engineering/traffic_engineering.py"
click node_static_router "https://github.com/community-vyprojects/vymanager/blob/beta/backend/routers/static_routes/static_routes.py"
click node_dispatch "https://github.com/community-vyprojects/vymanager/blob/beta/backend/batch_dispatch.py"
click node_session_service "https://github.com/community-vyprojects/vymanager/blob/beta/backend/session_vyos_service.py"
click node_builders "https://github.com/community-vyprojects/vymanager/tree/beta/backend/vyos_builders"
click node_te_builder "https://github.com/community-vyprojects/vymanager/blob/beta/backend/vyos_builders/traffic_engineering/traffic_engineering_batch_builder.py"
click node_mapper_registry "https://github.com/community-vyprojects/vymanager/blob/beta/backend/vyos_mappers/base.py"
click node_mappers "https://github.com/community-vyprojects/vymanager/tree/beta/backend/vyos_mappers"
click node_vyos_service "https://github.com/community-vyprojects/vymanager/blob/beta/backend/vyos_service.py"
click node_dashboards "https://github.com/community-vyprojects/vymanager/tree/beta/frontend/src"
click node_events "https://github.com/community-vyprojects/vymanager/blob/beta/backend/events/event_manager.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_frontend,node_feature_ui,node_api_client,node_dashboards toneBlue
class node_auth,node_session,node_permissions,node_rbac,node_postgres toneAmber
class node_app,node_routers,node_te_router,node_static_router,node_dispatch,node_session_service,node_events,node_router toneMint
class node_builders,node_te_builder,node_mapper_registry,node_mappers,node_vyos_service toneRose
class node_user toneIndigo
```

## Components

### Web interface

- [Management UI](https://github.com/community-vyprojects/vymanager/tree/beta/frontend/src): `frontend/src`
- [Feature forms](https://github.com/community-vyprojects/vymanager/tree/beta/frontend/src/components): `frontend/src/components`
- [Frontend API](https://github.com/community-vyprojects/vymanager/tree/beta/frontend/src/lib/api): `frontend/src/lib/api`
- [Live dashboards](https://github.com/community-vyprojects/vymanager/tree/beta/frontend/src): `frontend/src`

### Identity and access

- [Authentication](https://github.com/community-vyprojects/vymanager/blob/beta/backend/middleware/auth.py): `backend/middleware/auth.py`
- [Session middleware](https://github.com/community-vyprojects/vymanager/blob/beta/backend/middleware/session.py): `backend/middleware/session.py`
- [Permission checks](https://github.com/community-vyprojects/vymanager/blob/beta/backend/fastapi_permissions.py): `backend/fastapi_permissions.py`
- [RBAC rules](https://github.com/community-vyprojects/vymanager/blob/beta/backend/rbac_permissions.py): `backend/rbac_permissions.py`

### Configuration API

- [API application](https://github.com/community-vyprojects/vymanager/blob/beta/backend/app.py): `backend/app.py`
- [Feature endpoints](https://github.com/community-vyprojects/vymanager/tree/beta/backend/routers): `backend/routers`
- [Traffic engineering](https://github.com/community-vyprojects/vymanager/blob/beta/backend/routers/traffic_engineering/traffic_engineering.py): `backend/routers/traffic_engineering/traffic_engineering.py`
- [Static routes](https://github.com/community-vyprojects/vymanager/blob/beta/backend/routers/static_routes/static_routes.py): `backend/routers/static_routes/static_routes.py`
- [Batch dispatch](https://github.com/community-vyprojects/vymanager/blob/beta/backend/batch_dispatch.py): `backend/batch_dispatch.py`
- [Session VyOS service](https://github.com/community-vyprojects/vymanager/blob/beta/backend/session_vyos_service.py): `backend/session_vyos_service.py`
- [Event manager](https://github.com/community-vyprojects/vymanager/blob/beta/backend/events/event_manager.py): `backend/events/event_manager.py`

### VyOS translation

- [Feature builders](https://github.com/community-vyprojects/vymanager/tree/beta/backend/vyos_builders): `backend/vyos_builders`
- [TE batch builder](https://github.com/community-vyprojects/vymanager/blob/beta/backend/vyos_builders/traffic_engineering/traffic_engineering_batch_builder.py): `backend/vyos_builders/traffic_engineering/traffic_engineering_batch_builder.py`
- [Mapper registry](https://github.com/community-vyprojects/vymanager/blob/beta/backend/vyos_mappers/base.py): `backend/vyos_mappers/base.py`
- [Version mappers](https://github.com/community-vyprojects/vymanager/tree/beta/backend/vyos_mappers): `backend/vyos_mappers`
- [VyOS service](https://github.com/community-vyprojects/vymanager/blob/beta/backend/vyos_service.py): `backend/vyos_service.py`

### Other components

- **Operator**
- **VyOS router**
- **PostgreSQL**

## Connections

- Operator → Management UI: uses (evidence: `README.md`)
- Management UI → Feature forms: renders (evidence: `frontend/src/components/traffic-engineering/TrafficEngineeringContent.tsx`)
- Feature forms → Frontend API: requests
- Frontend API → API application: calls API
- API application → Authentication: installs (evidence: `backend/app.py`)
- API application → Session middleware: installs (evidence: `backend/app.py`)
- API application → Feature endpoints: registers (evidence: `backend/app.py`)
- Authentication → Session middleware: sets identity (evidence: `backend/middleware/auth.py`)
- Session middleware → Permission checks: sets request context (evidence: `backend/fastapi_permissions.py`)
- Permission checks → RBAC rules: checks roles (evidence: `backend/fastapi_permissions.py`)
- Feature endpoints → Permission checks: guards endpoints (evidence: `backend/routers/access_list/access_list.py`)
- Traffic engineering → Permission checks: checks access (evidence: `backend/routers/traffic_engineering/traffic_engineering.py`)
- Traffic engineering → Session VyOS service: resolves service (evidence: `backend/routers/traffic_engineering/traffic_engineering.py`)
- Static routes → Session VyOS service: resolves service (evidence: `backend/routers/static_routes/static_routes.py`)
- Feature endpoints → Batch dispatch: resolves operations (evidence: `backend/routers/access_list/access_list.py`)
- Traffic engineering → TE batch builder: builds commands (evidence: `backend/routers/traffic_engineering/traffic_engineering.py`)
- TE batch builder → Mapper registry: gets mapper (evidence: `backend/vyos_builders/traffic_engineering/traffic_engineering_batch_builder.py`)
- Feature builders → Mapper registry: uses registry
- Mapper registry → Version mappers: registers versions (evidence: `backend/vyos_mappers/__init__.py`)
- Session VyOS service → VyOS service: creates service (evidence: `backend/session_vyos_service.py`)
- Traffic engineering → VyOS service: executes batch (evidence: `backend/routers/traffic_engineering/traffic_engineering.py`)
- VyOS service → VyOS router: configures router
- Permission checks → PostgreSQL: reads permissions (evidence: `backend/fastapi_permissions.py`)
- Live dashboards → VyOS router: reads live data (evidence: `README.md`)
- API application → Event manager: registers routes
