https://github.com/Jamesits/pilot
Simple web-based SDN controller for family and friends
https://github.com/Jamesits/pilot
bgp bgp-flow-specification flowspec gobgp mpls sdn sdn-controller vrf
Last synced: 5 days ago
JSON representation
Simple web-based SDN controller for family and friends
- Host: GitHub
- URL: https://github.com/Jamesits/pilot
- Owner: Jamesits
- License: agpl-3.0
- Created: 2019-08-17T15:24:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-21T00:47:50.000Z (over 2 years ago)
- Last Synced: 2025-04-14T15:54:52.730Z (12 days ago)
- Topics: bgp, bgp-flow-specification, flowspec, gobgp, mpls, sdn, sdn-controller, vrf
- Language: Python
- Homepage: https://hub.docker.com/r/jamesits/pilot
- Size: 2.3 MB
- Stars: 34
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pilot
Simple web-based SDN controller for family and friends.
[](https://dev.azure.com/nekomimiswitch/General/_build/latest?definitionId=81&branchName=master)
## Introduction
Pilot is the SDN controller for your home. Once Pilot is set up, any device in your LAN can visit Pilot's web interface to easily select their own VRF.
## Requirements
Server running Pilot:
* Python 3.7 or later (if you don't use the Docker image)
* GoBGP with gRPC enabled (if you don't use the Docker image)
* LAN devices should not go through SNAT/masquerade to access the server (for proper IP address detection)
Gateway router:
* Has VRF-Lite capability
* Can act as a [BGP Flow Specification](https://tools.ietf.org/html/rfc5575) client
## Usage
### Router Setup
* Put different network profiles in different VRFs
* Add BGP session with your GoBGP instance and enable `ipv4 flowspec` and `ipv6 flowspec` address families
* Allow flowspec rule installation on the interfaces to LAN clients
Example configuration for Cisco IOS XE 16.x:
```
! Enable flowspec rule installation
flowspec
local-install interface-all
! VRF definition
ip vrf UPLINK1
rd 100:100
route-target both 100:100
ip vrf UPLINK2
rd 200:200
route-target both 200:200
! Uplink interfaces
interface GigabitEthernet0/0/0
description uplink-1
ip vrf select source
ip vrf receive UPLINK1
ip flowspec disable
ipv6 flowspec disable
interface GigabitEthernet0/0/1
description uplink-2
ip vrf select source
ip vrf receive UPLINK2
ip flowspec disable
ipv6 flowspec disable
! LAN interfaces
interface GigabitEthernet0/0/2
description LAN
ip address 192.168.1.1 255.255.255.0
ip vrf select source
ip vrf receive UPLINK1
ip vrf receive UPLINK2
! BGP peer setup
router bgp 65540
bgp router-id 169.254.1.2
neighbor 169.254.1.1 remote-as 65540
address-family ipv4 flowspec
neighbor 169.254.1.1 activate
address-family ipv6 flowspec
neighbor 169.254.1.1 activate
! Routes for global and VRFs
ip route 0.0.0.0 0.0.0.0 x.x.x.x 10
ip route 0.0.0.0 0.0.0.0 y.y.y.y 20
ip route vrf UPLINK1 0.0.0.0 0.0.0.0 x.x.x.x
ip route vrf UPLINK2 0.0.0.0 0.0.0.0 y.y.y.y
```
Example configuration for Juniper Junos OS (interface configuration left out):
```
set policy-options policy-statement accept-all term 1 then accept
set protocols bgp local-as 65540
set protocols bgp group flowspec family inet flow no-validate accept-all
set protocols bgp group flowspec family inet6 flow no-validate accept-all
set protocols bgp group flowspec neighbor 169.254.1.1 peer-as 65540
set routing-options flow term-order standard
# exclude your upstream interfaces:
# set routing-options flow interface-group [] [exclude ]
```
### Pilot Setup
The easiest way to run Pilot is using the [Docker image](https://hub.docker.com/r/jamesits/pilot). Download all the files in [config](config) and put them in a directory.
In `gobgpd.toml`:
* Change `global.config.as` and `global.config.router-id`
* Change `neighbors[].config.neighbor-address` and `neighbors[].config.peer-as`
In `pilot.toml`:
* Add or change `rule`
Then spin up our Docker container:
```shell
docker run --restart=always --name=pilot --network=host -v path/to/your/config/directory:/etc/pilot:ro jamesits/pilot:latest
```
The web UI will be on port 80.
## Thanks
This project is inspired by [xtomcom/NetworkSwitch](https://github.com/xtomcom/NetworkSwitch).