1
0
mirror of https://github.com/checktheroads/hyperglass synced 2024-05-11 05:55:08 +00:00
2020-01-02 09:52:27 -07:00
2019-12-31 18:30:48 -07:00
2019-07-16 01:13:07 -07:00
2019-08-22 22:37:01 -07:00
2019-08-29 23:05:38 -07:00
2019-09-25 23:48:33 -07:00
2020-01-02 09:52:27 -07:00
2019-12-31 18:30:48 -07:00
2020-01-02 09:52:27 -07:00
2019-12-31 00:07:54 -07:00

WARNING

This branch is very much under construction. There's a 99% chance that hyperglass will not function at all if you download and install from this branch. If you're looking for a working version of hyperglass, please go to the master branch.


hyperglass is a modern network looking glass application. A looking glass is typically implemented by network service providers as a way of providing customers, peers, and partners with a way to easily view elements of, or run tests from the provider's network.


Documentation   |   Screenshots   |   Live Demo

Build Status SCC Line Count Code style: black


hyperglass is intended to make implementing a looking glass too easy not to do, with the lofty goal of improving the internet community at large by making looking glasses more common across autonomous systems of any size.

Features

  • BGP Route, BGP Community, BGP AS Path, Ping, Traceroute
  • Full frontend and backend IPv6 support
  • Netmiko-based connection handling for traditional network devices
  • FRRouting support via hyperglass-frr REST API
  • BIRD support via hyperglass-bird REST API
  • Run queries against multiple routers asynchronously
  • Customizable commands for each query type by vendor
  • Clean, modern, GUI
  • Customizable colors, logo, web fonts, error messages, UI text
  • Simple YAML config file for all customizable parameters (no databases!)
  • Optional SSH Proxy to further direct secure router access
  • Configurable IP/Prefix "blacklist" to prevent lookup of sensitive prefixes
  • Configurable rate limiting
  • Query response caching with configurable cache timeout
  • Prometheus metrics for query statistics tracking

Platform Support

hyperglass is preconfigured to support the following platforms:

  • Cisco IOS-XR: Netmiko cisco_xr vendor class
  • Cisco Classic IOS/IOS-XE: Netmiko cisco_ios vendor class
  • Juniper JunOS: Netmiko junos vendor class
  • FRRouting: hyperglass-frr API
  • BIRD: hyperglass-bird API

Theoretically, any vendor supported by Netmiko can be supported by hyperglass. To request support for a specifc platform, please submit a Github Issue with the enhancement label.

Coming Soon

Community

There is now a hyperglass team on Keybase! Any users, potential users, or contributors of hyperglass are welcome to join to discuss usage, feature requests, bugs, and other things.

hyperglass is developed with the express intention of being free to the networking community.

However, the hyperglass demo does cost /checktheroads about $15/month for 3 Digital Ocean droplets. If you're feeling particularly helpful and want to help offset that cost, small donations are welcome.

Donate

License

Clear BSD License

Description
No description provided
Readme 48 MiB