checktheroads-hyperglass/README.md

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. hyperglass is intended to make implementing a looking glass too easy not to do, with the big-picture goal of improving the internet community as a whole by making looking glasses more common across autonomous systems of any size.

Features

• BGP Route, BGP Community, BGP AS Path, Ping, Traceroute
• Full IPv6 support
• Netmiko-based connection handling for traditional network devices
• FRRouting support via hyperglass-frr REST API
• Customizable commands for each query type by vendor
• Clean, modern, google-esq GUI based on the Bumla framework
• Customizable colors, logo, web fonts, error messages, UI text
• Simple TOML 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, powered by Flask-Limiter
• Query response caching with configurable cache timeout, powered by Flask-Caching
• Prometheus metrics for query statistics tracking

Documentation

Documentation can be found here, or in the docs/ directory.

Preview

For screenshots, see here, or the screenshots/ directory.

Platform Support

Theoretically, any vendor supported by Netmiko can be supported by hyperglass. However, hyperglass is preconfigured to support the following platforms:

Routers

• 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

Proxies

• Linux: linux_ssh

Acknowledgements

• This project originally started as a fork of vraulsan's looking-glass project. The guts of the Flask components still remain from that project, but almost everything else has been rewritten. Nevertheless, the inspiration for building hyperglass came from here.

License

Clear BSD License