mirror of
https://github.com/checktheroads/hyperglass
synced 2024-05-11 05:55:08 +00:00
74 lines
4.1 KiB
Markdown
74 lines
4.1 KiB
Markdown
# 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](https://github.com/checktheroads/hyperglass/tree/master)**.
|
|
|
|
<hr>
|
|
|
|
<img src="logo.png" width=300></img>
|
|
|
|
**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.
|
|
|
|
<hr>
|
|
|
|
<div align="center">
|
|
|
|
[**Documentation**](https://hyperglass.readthedocs.io) | [**Screenshots**](https://hyperglass.readthedocs.io/en/latest/screenshots/) | [**Live Demo**](https://hyperglass.allroads.io/)
|
|
|
|
[](https://travis-ci.org/checktheroads/hyperglass)
|
|
|
|
[](https://github.com/ambv/black)
|
|
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
**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](https://github.com/ktbyers/netmiko)-based connection handling for traditional network devices
|
|
- [FRRouting](https://frrouting.org/) support via [hyperglass-frr](https://github.com/checktheroads/hyperglass-frr) REST API
|
|
- [BIRD](https://bird.network.cz/) support via [hyperglass-bird](https://github.com/checktheroads/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](https://prometheus.io/) 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`](https://github.com/checktheroads/hyperglass-frr) API
|
|
- **BIRD**: [`hyperglass-bird`](https://github.com/checktheroads/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](https://github.com/checktheroads/hyperglass/issues/new) with the **enhancement** label.
|
|
|
|
## Coming Soon
|
|
|
|
- [GoBGP](https://github.com/osrg/gobgp) Support
|
|
|
|
## Community
|
|
|
|
There is now a [hyperglass team](https://keybase.io/team/hyperglass) on [Keybase](https://keybase.io/)! 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](https://github.com/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.*
|
|
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZQFH3BB2B5M3E&source=url)
|
|
|
|
## License
|
|
|
|
[Clear BSD License](https://github.com/checktheroads/hyperglass/master/LICENSE)
|