rhicks / bgp-dashboard Goto Github PK

View Code? Open in Web Editor NEW

351.0 28.0 72.0 13.64 MB

BGP Dashboard and Monitoring Web Application

Python 21.09% CSS 58.53% HTML 18.90% Shell 0.17% Dockerfile 1.30%

bgp bgp-monitoring-protocol docker gobgp bgp-dashboard flask peer mongodb docker-compose ipv4 ipv6 looking-glass

bgp-dashboard's Introduction

BGP Dashboard

A "realtime" web view of your BGP network

Who do I peer with?
How many routes do I receive from my peers?
Who do I use for tranist?
What AS path does a prefix take out of my network?
How many routes and autonomous systems do I see?
BGP Looking Glass (IPv4/IPv6/ASN)

How it works

This is beta code.

BGP peering session using GoBGP
GoBGP pipes BGP information into MongoDB
Flask App queries MongoDB to build website and JSON API

This project uses three Docker containers

GoBGP (osrg/gobgp)
MongoDB (mongo)
Flask (docker-flask)

GoBGP

The GoBGP container serves two functions:

Peer with the "real" network
- Configure gobgpd.conf to peer with the real network.
- Only IPv4-Unicast and IPv6-Unicast supported at this time.
Pass BGP updates into BGP
- The gobgp_to_mongo.py script pipes the JSON updates from GoBGP into the MongoDB container

MongoDB

Mongo receives JSON updates from the GoBGP container
The Flask App queries Mongo for relevant information

Flask

Flask presents a Dashboard for realtime BGP updates
A JSON API is used on the backend to support the frontend and display Looking Glass queries

Screenshot

Install

$ git clone https://github.com/rhicks/bgp-dashboard.git
$ cd bgp-dashboard
$ # modify ./gobgp/gobgpd.conf to peer with your network
$ # modify ./flask/app/constants.py globals to use your ASN and BGP communities
$ docker-compose build
$ docker-compose up (watch the log to verify BGP peeering is established)

Todo

bgp-dashboard's People

Contributors

Stargazers

Watchers

bgp-dashboard's Issues

GoBGP seems to exit over and over.

Mongo is saving data but the dashboard is not displaying it--

I know this hasn't been maintained for some time but it's a very cool project and I was wondering if you'd be willing to do a revamp? :DD

Issues with the gobgp_to_mongo.py file

Hi,

After following the tutorial, we got the dashboard running. However, it is not being updated with new data.

The following errors keep popping up constantly when we run the build:

gobgp_1 | File "/var/tmp/gobgp_to_mongo.py", line 177, in
gobgp_1 | sys.exit(main())
gobgp_1 | File "/var/tmp/gobgp_to_mongo.py", line 167, in main
gobgp_1 | prefix_from_gobgp = build_json(get_update_entry(line))
gobgp_1 | File "/var/tmp/gobgp_to_mongo.py", line 75, in build_json
gobgp_1 | '_id': update_entry['nlri']['prefix'],
gobgp_1 | TypeError: 'NoneType' object is not subscriptable

it is support for ubuntu 20.04.4 ?

Hello i see ubuntu 17.10 did not support again, and i not familiar with alpine

exabgp (feature request)

Greetings,

are there any plans for support for exabgp?

regards

Many thanks !!!

Does it support ebgp-multihop ?

gobgp docker doesn't start

When starting the docker images with either:

# docker-compose up
# docker-compose up -d

The gobgp image doesn't stay running.

There is a race condition I haven't figured out yet.
Just keep running the docker-compose up command over and over until it starts.
You can check if it is running using the docker ps command.

You should see all three containers when things are working correctly:

# docker ps
CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS              PORTS                  NAMES
ab4ac0d3bc46        bgpdash_flask       "/usr/bin/supervisord"   22 seconds ago      Up 18 seconds       0.0.0.0:80->80/tcp     bgpdash_flask_1
ec2546ce400b        bgpdash_gobgp       "/bin/sh -c /root/gob"   22 seconds ago      Up 6 seconds        0.0.0.0:179->179/tcp   bgpdash_gobgp_1
e520b32708a4        bgpdash_mongo       "/entrypoint.sh mongo"   24 seconds ago      Up 22 seconds       27017/tcp              bgpdash_mongo_1