# yanet-platform/yanet architecture

> Architecture diagram of the GitHub repository yanet-platform/yanet, 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/yanet-platform/yanet
- Repository: https://github.com/yanet-platform/yanet

## Overview

YANET is a DPDK-based, high-performance software traffic-forwarding framework. Its principal workflow is packet ingress, dataplane classification and service processing, then routing and egress; operators also configure and inspect the system through the CLI and control plane. The README documents routing, ACL/firewall, load balancing, tunneling, NAT, and telemetry capabilities. Source excerpts show dataplane worker handling of ACL lookup, routing, stateful NAT, and flow dispatch, but do not expose the full control-plane wiring; uncertain links are dashed.

Main entry points: [`dataplane/worker.cpp`](https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp) (Packet worker), [`controlplane/controlplane.cpp`](https://github.com/yanet-platform/yanet/blob/main/controlplane/controlplane.cpp) (Control plane), [`dataplane/dpdk.cpp`](https://github.com/yanet-platform/yanet/blob/main/dataplane/dpdk.cpp) (DPDK ports), [`cli/main.cpp`](https://github.com/yanet-platform/yanet/blob/main/cli/main.cpp) (YANET CLI)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_operator["Operations"]
  node_cli["YANET CLI<br/>[main.cpp]"]
  node_cli_telemetry["Telemetry CLI<br/>[telegraf.h]"]
end

subgraph group_control["Control plane"]
  node_controlplane["Control plane<br/>[controlplane.cpp]"]
  node_config_parser["Config parser<br/>[configparser.cpp]"]
  node_config_converter["Config converter"]
  node_control_api["Control API<br/>[icontrolplane.h]"]
  node_data_api["Dataplane API<br/>[idataplane.h]"]
  node_acl_compiler["ACL compiler<br/>[acl_compiler.cpp]"]
  node_rib["Routing information<br/>[rib.cpp]"]
  node_acl_rules["ACL rules<br/>[rule.h]"]
end

subgraph group_forward["Packet forwarding"]
  node_ports["DPDK ports<br/>[dpdk.cpp]"]
  node_worker["Packet worker<br/>[worker.cpp]"]
  node_route_lookup["Route lookup<br/>[worker.cpp]"]
  node_neighbor["Neighbor resolution<br/>[neighbor.cpp]"]
  node_dataplane["Dataplane runtime<br/>[dataplane.h]"]
  node_memory["Memory manager<br/>[memory_manager.h]"]
end

subgraph group_services["Traffic services"]
  node_firewall["Stateful firewall<br/>[worker.cpp]"]
  node_load_balancer["Layer-4 balancer<br/>[balancer.cpp]"]
  node_nat["NAT64<br/>[worker.cpp]"]
  node_tunnels["Tunnels<br/>[tun64.cpp]"]
end

subgraph group_telemetry["Observability"]
  node_telemetry["Telemetry<br/>[telegraf.cpp]"]
end

node_operator_user(("Operator"))
node_network(("Network traffic"))

node_operator_user -->|"runs commands"| node_cli
node_cli -.->|"issues requests"| node_control_api
node_control_api -.->|"configures"| node_controlplane
node_config_parser -.->|"parses configuration"| node_controlplane
node_config_converter -.->|"converts configuration"| node_controlplane
node_controlplane -.->|"compiles rules"| node_acl_compiler
node_controlplane -.->|"maintains routes"| node_rib
node_acl_compiler -.->|"uses rules"| node_acl_rules
node_network -->|"sends packets"| node_ports
node_ports -.->|"dispatches packets"| node_worker
node_worker -->|"checks ACL"| node_firewall
node_worker -->|"translates flows"| node_nat
node_worker -->|"looks up routes"| node_route_lookup
node_route_lookup -.->|"resolves next hop"| node_neighbor
node_worker -.->|"dispatches flows"| node_load_balancer
node_worker -.->|"encapsulates traffic"| node_tunnels
node_route_lookup -.->|"uses route data"| node_rib
node_worker -.->|"forwards packets"| node_ports
node_ports -->|"emits packets"| node_network
node_controlplane -.->|"updates dataplane"| node_data_api
node_data_api -.->|"requests operations"| node_dataplane
node_dataplane -.->|"manages allocations"| node_memory
node_controlplane -.->|"exports telemetry"| node_telemetry
node_cli_telemetry -.->|"configures reporting"| node_telemetry
node_operator_user -.->|"inspects metrics"| node_cli_telemetry

click node_cli "https://github.com/yanet-platform/yanet/blob/main/cli/main.cpp"
click node_cli_telemetry "https://github.com/yanet-platform/yanet/blob/main/cli/telegraf.h"
click node_controlplane "https://github.com/yanet-platform/yanet/blob/main/controlplane/controlplane.cpp"
click node_config_parser "https://github.com/yanet-platform/yanet/blob/main/controlplane/configparser.cpp"
click node_config_converter "https://github.com/yanet-platform/yanet/blob/main/controlplane/configconverter.cpp"
click node_control_api "https://github.com/yanet-platform/yanet/blob/main/common/icontrolplane.h"
click node_data_api "https://github.com/yanet-platform/yanet/blob/main/common/idataplane.h"
click node_acl_compiler "https://github.com/yanet-platform/yanet/blob/main/controlplane/acl_compiler.cpp"
click node_rib "https://github.com/yanet-platform/yanet/blob/main/controlplane/rib.cpp"
click node_acl_rules "https://github.com/yanet-platform/yanet/blob/main/controlplane/acl/rule.h"
click node_ports "https://github.com/yanet-platform/yanet/blob/main/dataplane/dpdk.cpp"
click node_worker "https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp"
click node_route_lookup "https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp"
click node_neighbor "https://github.com/yanet-platform/yanet/blob/main/dataplane/neighbor.cpp"
click node_firewall "https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp"
click node_load_balancer "https://github.com/yanet-platform/yanet/blob/main/controlplane/balancer.cpp"
click node_nat "https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp"
click node_tunnels "https://github.com/yanet-platform/yanet/blob/main/controlplane/tun64.cpp"
click node_telemetry "https://github.com/yanet-platform/yanet/blob/main/controlplane/telegraf.cpp"
click node_dataplane "https://github.com/yanet-platform/yanet/blob/main/dataplane/dataplane.h"
click node_memory "https://github.com/yanet-platform/yanet/blob/main/dataplane/memory_manager.h"

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_cli,node_cli_telemetry toneBlue
class node_controlplane,node_config_parser,node_config_converter,node_control_api,node_data_api,node_acl_compiler,node_rib,node_acl_rules toneAmber
class node_ports,node_worker,node_route_lookup,node_neighbor,node_dataplane,node_memory toneMint
class node_firewall,node_load_balancer,node_nat,node_tunnels toneRose
class node_telemetry,node_operator_user,node_network toneIndigo
```

## Components

### Operations

- [YANET CLI](https://github.com/yanet-platform/yanet/blob/main/cli/main.cpp): `cli/main.cpp`
- [Telemetry CLI](https://github.com/yanet-platform/yanet/blob/main/cli/telegraf.h): `cli/telegraf.h`

### Control plane

- [Control plane](https://github.com/yanet-platform/yanet/blob/main/controlplane/controlplane.cpp): `controlplane/controlplane.cpp`
- [Config parser](https://github.com/yanet-platform/yanet/blob/main/controlplane/configparser.cpp): `controlplane/configparser.cpp`
- [Config converter](https://github.com/yanet-platform/yanet/blob/main/controlplane/configconverter.cpp): `controlplane/configconverter.cpp`
- [Control API](https://github.com/yanet-platform/yanet/blob/main/common/icontrolplane.h): `common/icontrolplane.h`
- [Dataplane API](https://github.com/yanet-platform/yanet/blob/main/common/idataplane.h): `common/idataplane.h`
- [ACL compiler](https://github.com/yanet-platform/yanet/blob/main/controlplane/acl_compiler.cpp): `controlplane/acl_compiler.cpp`
- [Routing information](https://github.com/yanet-platform/yanet/blob/main/controlplane/rib.cpp): `controlplane/rib.cpp`
- [ACL rules](https://github.com/yanet-platform/yanet/blob/main/controlplane/acl/rule.h): `controlplane/acl/rule.h`

### Packet forwarding

- [DPDK ports](https://github.com/yanet-platform/yanet/blob/main/dataplane/dpdk.cpp): `dataplane/dpdk.cpp`
- [Packet worker](https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp): `dataplane/worker.cpp`
- [Route lookup](https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp): `dataplane/worker.cpp`
- [Neighbor resolution](https://github.com/yanet-platform/yanet/blob/main/dataplane/neighbor.cpp): `dataplane/neighbor.cpp`
- [Dataplane runtime](https://github.com/yanet-platform/yanet/blob/main/dataplane/dataplane.h): `dataplane/dataplane.h`
- [Memory manager](https://github.com/yanet-platform/yanet/blob/main/dataplane/memory_manager.h): `dataplane/memory_manager.h`

### Traffic services

- [Stateful firewall](https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp): `dataplane/worker.cpp`
- [Layer-4 balancer](https://github.com/yanet-platform/yanet/blob/main/controlplane/balancer.cpp): `controlplane/balancer.cpp`
- [NAT64](https://github.com/yanet-platform/yanet/blob/main/dataplane/worker.cpp): `dataplane/worker.cpp`
- [Tunnels](https://github.com/yanet-platform/yanet/blob/main/controlplane/tun64.cpp): `controlplane/tun64.cpp`

### Observability

- [Telemetry](https://github.com/yanet-platform/yanet/blob/main/controlplane/telegraf.cpp): `controlplane/telegraf.cpp`

### Other components

- **Operator**
- **Network traffic**

## Connections

- Operator → YANET CLI: runs commands (evidence: `cli/main.cpp`)
- YANET CLI → Control API: issues requests
- Control API → Control plane: configures
- Config parser → Control plane: parses configuration
- Config converter → Control plane: converts configuration
- Control plane → ACL compiler: compiles rules
- Control plane → Routing information: maintains routes
- ACL compiler → ACL rules: uses rules
- Network traffic → DPDK ports: sends packets
- DPDK ports → Packet worker: dispatches packets
- Packet worker → Stateful firewall: checks ACL (evidence: `dataplane/worker.cpp`)
- Packet worker → NAT64: translates flows (evidence: `dataplane/worker.cpp`)
- Packet worker → Route lookup: looks up routes (evidence: `dataplane/worker.cpp`)
- Route lookup → Neighbor resolution: resolves next hop
- Packet worker → Layer-4 balancer: dispatches flows
- Packet worker → Tunnels: encapsulates traffic
- Route lookup → Routing information: uses route data
- Packet worker → DPDK ports: forwards packets
- DPDK ports → Network traffic: emits packets
- Control plane → Dataplane API: updates dataplane
- Dataplane API → Dataplane runtime: requests operations
- Dataplane runtime → Memory manager: manages allocations (evidence: `dataplane/dataplane.h`)
- Control plane → Telemetry: exports telemetry
- Telemetry CLI → Telemetry: configures reporting
- Operator → Telemetry CLI: inspects metrics
