# project-kelvin/openrase architecture

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

- Interactive diagram: https://gitdiagram.com/project-kelvin/openrase
- Repository: https://github.com/project-kelvin/openrase

## Overview

OpenRASE emulates NFV service-function-chain placement and benchmarks resource-allocation strategies. A run configures a virtual topology, generates SFC requests, solves placements into embedding graphs, and sends them through the orchestrator for VNF deployment and network setup; traffic generation and telemetry support evaluation. The repository also contains DRL, greedy, genetic, and hybrid solvers, plus calibration and benchmarking. Several links are based on SOURCE INDEX references rather than complete excerpts, so unsampled implementation details are not expanded.

Main entry points: [`src/sfc/solver.py`](https://github.com/project-kelvin/openrase/blob/main/src/sfc/solver.py) (Solver dispatch), [`src/runs`](https://github.com/project-kelvin/openrase/tree/main/src/runs) (Experiment runners), [`src/sfc/sfc_emulator.py`](https://github.com/project-kelvin/openrase/blob/main/src/sfc/sfc_emulator.py) (SFC emulator), [`src/mano/orchestrator.py`](https://github.com/project-kelvin/openrase/blob/main/src/mano/orchestrator.py) (Orchestrator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Emulation workflow"]
  node_run["Experiment runners"]
  node_emulator["SFC emulator<br/>[sfc_emulator.py]"]
  node_requests["SFC request generation"]
  node_solver["Solver dispatch<br/>[solver.py]"]
  node_traffic["Traffic generation"]
end

subgraph group_control["NFV control plane"]
  node_orchestrator["Orchestrator<br/>[orchestrator.py]"]
  node_infrastructure["Infrastructure manager<br/>[infra_manager.py]"]
  node_vnf["VNF manager<br/>[vnf_manager.py]"]
  node_sdn["SDN controller<br/>[sdn_controller.py]"]
  node_notifications["Notifications"]
end

subgraph group_algorithms["Placement algorithms"]
  node_drl["DRL embedding"]
  node_greedy["Greedy Dijkstra"]
  node_genetic["Genetic Dijkstra"]
  node_hybrid["Hybrid solvers"]
end

subgraph group_evaluation["Evaluation and shared models"]
  node_telemetry["Telemetry<br/>[telemetry.py]"]
  node_calibration["Calibration benchmarks<br/>[run_benchmark.py]"]
  node_embedding["Embedding graph model<br/>[embedding_graph.py]"]
  node_requestmodel["SFC request model<br/>[sfc_request.py]"]
  node_topologymodel["Topology model<br/>[topology.py]"]
  node_trafficmodel["Traffic design model<br/>[traffic_design.py]"]
  node_config["Configuration<br/>[config.py]"]
  node_tui["Progress interface<br/>[tui.py]"]
end

node_researcher(("Researcher"))
node_network["Emulated network"]
node_docker["Docker containers"]
node_ryu["Ryu controller"]
node_influx[("InfluxDB")]

node_researcher -->|"starts experiment"| node_run
node_run -->|"runs emulation"| node_emulator
node_run -->|"uses solver"| node_solver
node_run -->|"configures orchestration"| node_orchestrator
node_emulator -->|"generates requests"| node_requests
node_emulator -->|"dispatches requests"| node_solver
node_solver -->|"submits placements"| node_orchestrator
node_orchestrator -->|"deploys graphs"| node_vnf
node_orchestrator -->|"installs topology"| node_infrastructure
node_orchestrator -->|"gets telemetry"| node_telemetry
node_infrastructure -->|"configures flows"| node_sdn
node_infrastructure -->|"builds topology"| node_network
node_vnf -->|"embeds SFC"| node_infrastructure
node_vnf -->|"runs VNF containers"| node_docker
node_vnf -->|"publishes deployment"| node_notifications
node_sdn -->|"installs flow rules"| node_ryu
node_traffic -->|"subscribes to events"| node_notifications
node_traffic -->|"starts traffic containers"| node_docker
node_traffic -.->|"reads measurements"| node_influx
node_run -->|"selects algorithm"| node_drl
node_run -->|"selects algorithm"| node_hybrid
node_solver -.->|"dispatches strategy"| node_greedy
node_solver -.->|"dispatches strategy"| node_genetic
node_calibration -->|"benchmarks emulation"| node_emulator
node_calibration -->|"benchmarks solver"| node_solver
node_emulator -->|"logs progress"| node_tui
node_run -->|"loads settings"| node_config
node_solver -->|"uses graph model"| node_embedding
node_solver -->|"accepts requests"| node_requestmodel
node_infrastructure -->|"uses topology model"| node_topologymodel
node_traffic -->|"uses traffic design"| node_trafficmodel

click node_run "https://github.com/project-kelvin/openrase/tree/main/src/runs"
click node_emulator "https://github.com/project-kelvin/openrase/blob/main/src/sfc/sfc_emulator.py"
click node_requests "https://github.com/project-kelvin/openrase/blob/main/src/sfc/sfc_request_generator.py"
click node_solver "https://github.com/project-kelvin/openrase/blob/main/src/sfc/solver.py"
click node_traffic "https://github.com/project-kelvin/openrase/blob/main/src/sfc/traffic_generator.py"
click node_orchestrator "https://github.com/project-kelvin/openrase/blob/main/src/mano/orchestrator.py"
click node_infrastructure "https://github.com/project-kelvin/openrase/blob/main/src/mano/infra_manager.py"
click node_vnf "https://github.com/project-kelvin/openrase/blob/main/src/mano/vnf_manager.py"
click node_sdn "https://github.com/project-kelvin/openrase/blob/main/src/mano/sdn_controller.py"
click node_notifications "https://github.com/project-kelvin/openrase/blob/main/src/mano/notification_system.py"
click node_telemetry "https://github.com/project-kelvin/openrase/blob/main/src/mano/telemetry.py"
click node_drl "https://github.com/project-kelvin/openrase/blob/main/src/algorithms/drl_sfcr_embedding.py"
click node_greedy "https://github.com/project-kelvin/openrase/blob/main/src/algorithms/greedy_dijkstra_algorithm.py"
click node_genetic "https://github.com/project-kelvin/openrase/tree/main/src/algorithms/ga_dijkstra_algorithm"
click node_hybrid "https://github.com/project-kelvin/openrase/tree/main/src/algorithms/hybrid"
click node_calibration "https://github.com/project-kelvin/openrase/blob/main/src/calibrate/run_benchmark.py"
click node_embedding "https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/models/embedding_graph.py"
click node_requestmodel "https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/models/sfc_request.py"
click node_topologymodel "https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/models/topology.py"
click node_trafficmodel "https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/models/traffic_design.py"
click node_config "https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/utils/config.py"
click node_tui "https://github.com/project-kelvin/openrase/blob/main/src/utils/tui.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_run,node_emulator,node_requests,node_solver,node_traffic toneBlue
class node_orchestrator,node_infrastructure,node_vnf,node_sdn,node_notifications,node_influx toneAmber
class node_drl,node_greedy,node_genetic,node_hybrid toneMint
class node_telemetry,node_calibration,node_embedding,node_requestmodel,node_topologymodel,node_trafficmodel,node_config,node_tui toneRose
class node_researcher,node_network,node_docker,node_ryu toneIndigo
```

## Components

### Emulation workflow

- [Experiment runners](https://github.com/project-kelvin/openrase/tree/main/src/runs): `src/runs`
- [SFC emulator](https://github.com/project-kelvin/openrase/blob/main/src/sfc/sfc_emulator.py): `src/sfc/sfc_emulator.py`
- [SFC request generation](https://github.com/project-kelvin/openrase/blob/main/src/sfc/sfc_request_generator.py): `src/sfc/sfc_request_generator.py`
- [Solver dispatch](https://github.com/project-kelvin/openrase/blob/main/src/sfc/solver.py): `src/sfc/solver.py`
- [Traffic generation](https://github.com/project-kelvin/openrase/blob/main/src/sfc/traffic_generator.py): `src/sfc/traffic_generator.py`

### NFV control plane

- [Orchestrator](https://github.com/project-kelvin/openrase/blob/main/src/mano/orchestrator.py): `src/mano/orchestrator.py`
- [Infrastructure manager](https://github.com/project-kelvin/openrase/blob/main/src/mano/infra_manager.py): `src/mano/infra_manager.py`
- [VNF manager](https://github.com/project-kelvin/openrase/blob/main/src/mano/vnf_manager.py): `src/mano/vnf_manager.py`
- [SDN controller](https://github.com/project-kelvin/openrase/blob/main/src/mano/sdn_controller.py): `src/mano/sdn_controller.py`
- [Notifications](https://github.com/project-kelvin/openrase/blob/main/src/mano/notification_system.py): `src/mano/notification_system.py`

### Placement algorithms

- [DRL embedding](https://github.com/project-kelvin/openrase/blob/main/src/algorithms/drl_sfcr_embedding.py): `src/algorithms/drl_sfcr_embedding.py`
- [Greedy Dijkstra](https://github.com/project-kelvin/openrase/blob/main/src/algorithms/greedy_dijkstra_algorithm.py): `src/algorithms/greedy_dijkstra_algorithm.py`
- [Genetic Dijkstra](https://github.com/project-kelvin/openrase/tree/main/src/algorithms/ga_dijkstra_algorithm): `src/algorithms/ga_dijkstra_algorithm`
- [Hybrid solvers](https://github.com/project-kelvin/openrase/tree/main/src/algorithms/hybrid): `src/algorithms/hybrid`

### Evaluation and shared models

- [Telemetry](https://github.com/project-kelvin/openrase/blob/main/src/mano/telemetry.py): `src/mano/telemetry.py`
- [Calibration benchmarks](https://github.com/project-kelvin/openrase/blob/main/src/calibrate/run_benchmark.py): `src/calibrate/run_benchmark.py`
- [Embedding graph model](https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/models/embedding_graph.py): `packages/python/shared/models/embedding_graph.py`
- [SFC request model](https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/models/sfc_request.py): `packages/python/shared/models/sfc_request.py`
- [Topology model](https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/models/topology.py): `packages/python/shared/models/topology.py`
- [Traffic design model](https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/models/traffic_design.py): `packages/python/shared/models/traffic_design.py`
- [Configuration](https://github.com/project-kelvin/openrase/blob/main/packages/python/shared/utils/config.py): `packages/python/shared/utils/config.py`
- [Progress interface](https://github.com/project-kelvin/openrase/blob/main/src/utils/tui.py): `src/utils/tui.py`

### Other components

- **Researcher**
- **Emulated network**
- **Docker containers**
- **Ryu controller**
- **InfluxDB**

## Connections

- Researcher → Experiment runners: starts experiment (evidence: `README.md`)
- Experiment runners → SFC emulator: runs emulation (evidence: `src/runs/hybrid/genesis.py`)
- Experiment runners → Solver dispatch: uses solver (evidence: `src/runs/hybrid/genesis.py`)
- Experiment runners → Orchestrator: configures orchestration (evidence: `src/runs/hybrid/genesis.py`)
- SFC emulator → SFC request generation: generates requests (evidence: `src/sfc/sfc_emulator.py`)
- SFC emulator → Solver dispatch: dispatches requests (evidence: `src/sfc/sfc_emulator.py`)
- Solver dispatch → Orchestrator: submits placements (evidence: `src/sfc/solver.py`)
- Orchestrator → VNF manager: deploys graphs (evidence: `src/mano/orchestrator.py`)
- Orchestrator → Infrastructure manager: installs topology (evidence: `src/mano/orchestrator.py`)
- Orchestrator → Telemetry: gets telemetry (evidence: `src/mano/orchestrator.py`)
- Infrastructure manager → SDN controller: configures flows (evidence: `src/mano/infra_manager.py`)
- Infrastructure manager → Emulated network: builds topology (evidence: `src/mano/infra_manager.py`)
- VNF manager → Infrastructure manager: embeds SFC (evidence: `src/mano/vnf_manager.py`)
- VNF manager → Docker containers: runs VNF containers (evidence: `src/mano/vnf_manager.py`)
- VNF manager → Notifications: publishes deployment (evidence: `src/mano/vnf_manager.py`)
- SDN controller → Ryu controller: installs flow rules (evidence: `src/mano/sdn_controller.py`)
- Traffic generation → Notifications: subscribes to events (evidence: `src/sfc/traffic_generator.py`)
- Traffic generation → Docker containers: starts traffic containers (evidence: `src/sfc/traffic_generator.py`)
- Traffic generation → InfluxDB: reads measurements
- Experiment runners → DRL embedding: selects algorithm (evidence: `src/runs/drl_sfcr/run.py`)
- Experiment runners → Hybrid solvers: selects algorithm (evidence: `src/runs/hybrid/genesis.py`)
- Solver dispatch → Greedy Dijkstra: dispatches strategy
- Solver dispatch → Genetic Dijkstra: dispatches strategy
- Calibration benchmarks → SFC emulator: benchmarks emulation (evidence: `src/calibrate/run_benchmark.py`)
- Calibration benchmarks → Solver dispatch: benchmarks solver (evidence: `src/calibrate/run_benchmark.py`)
- SFC emulator → Progress interface: logs progress (evidence: `src/sfc/sfc_emulator.py`)
- Experiment runners → Configuration: loads settings (evidence: `src/runs/hybrid/genesis.py`)
- Solver dispatch → Embedding graph model: uses graph model (evidence: `src/sfc/solver.py`)
- Solver dispatch → SFC request model: accepts requests (evidence: `src/sfc/solver.py`)
- Infrastructure manager → Topology model: uses topology model (evidence: `src/mano/infra_manager.py`)
- Traffic generation → Traffic design model: uses traffic design (evidence: `src/sfc/traffic_generator.py`)
