Skip to content

kytos-ng/pathfinder

 
 

Repository files navigation

Stable Tag License Build status Code coverage Code-quality score

kytos/pathfinder

NApp that finds network paths

Overview

pathfinder is responsible for creating a graph with the latest network topology and providing rest endpoint to calculate the best path between two devices. In the network, each device is a host or a switch and each link is a connection between two devices. In the graph, each device represents a node and each link represents an edge between two nodes.

The NApp learns custom properties from the topology, being able to define the best paths based on a weighted parameter. Please see the Rest API documentation for details.

Features

  • REST API to find constrained network paths
  • Keep track of the current network graph to find constrained paths
  • Web UI

Installing

To install this NApp, first, make sure to have the same venv activated as you have kytos installed on:

$ git clone https://github.com/kytos-ng/pathfinder.git
$ cd pathfinder
$ python3 -m pip install --editable .

To install the kytos environment, please follow our development environment setup.

Requirements

Events

Subscribed

  • kytos/topology.topology_loaded
  • kytos/topology.updated