checktheroads-hyperglass/README.md

Hyperglass is a 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.

Features

• BGP Route, BGP Community, BGP AS_PATH, Ping, Traceroute
• Full IPv6 support
• Netmiko-based connection handling
• Customizable commands for each function by vendor
• Clean, google-esq GUI based on the Bumla framework
• Customizable colors, logo, web fonts, error messages, UI text
• TOML-based config file for all customizable parameters (no databases!)
• Configurable IP/Prefix "blacklist" to prevent lookup of internal/private prefixes
• Configurable rate limiting, powered by Flask-Limiter
• Query response caching with configurable cache timeout, powered by Flask-Caching

Documentation

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

Preview

Platform Support

Theoretically, any vendor supported by Netmiko can be supported by Hyperglass. However, I am currently listing platforms I have personally tested and verified full functionality with:

Routers

• Cisco IOS-XR: cisco_xr
• Cisco Classic IOS/IOS-XE: cisco_ios
• Juniper JunOS: junos

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