mirrors/thatmattlove-hyperglass
1
0
Fork 1
mirror of https://github.com/thatmattlove/hyperglass.git synced 2026-01-17 08:48:05 +00:00
Code Issues Activity

Add development status [skip ci]

Browse source
This commit is contained in:
Matt Love 2019-09-14 18:19:53 -07:00 • committed by GitHub
parent 128a5d427b
commit d71a71a949
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 50 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -69,3 +69,53 @@ There is now a [hyperglass team](https://keybase.io/team/hyperglass) on [Keybase
## License
[Clear BSD License](https://github.com/checktheroads/hyperglass/blob/master/LICENSE)
# *Development Status*
Beginning 2019-09-01, the *initial* release of **hyperglass** will only receive updates for critical bug fixes or vulnerabilities. Any enhancements, new features, or other general improvements will, if accepted/approved, be implemented in version 1.0.0, development for which can be tracked via the [v1.0.0 branch](https://github.com/checktheroads/hyperglass/tree/v1.0.0).
## But why
The initial release of hyperglass was the culmination of my first ever foray into development, so naturally it is not perfect. Building that initial release was an incredibly fun process through which I learned a *lot*, and the community's feedback has been overwhelmingly positive. However, after the initial release I still had a massive list of features I wanted to try to implement. As I began that process, I found many aspects of the hyperglass backend that needed improving (or in some cases, significant overhaul). So, I decided to put all my efforts into a single "1.0" release and treat the initial hyperglass release as more of a beta. This way, I'm able to dedicate what little development time I have to the drastic improvements in the works in the v1.0.0 branch.
## What's coming in 1.0?
##### So far, I've already implemented the following:
:heavy_check_mark: [Asyncio](https://docs.python.org/3/library/asyncio.html) end-to-end wherever possible
:heavy_check_mark: Migrated web framework from Flask to [Sanic](https://github.com/huge-success/sanic) (removes Gunicorn dependency)
:heavy_check_mark: Migrated outbound http client framework from Requests to [HTTPX](https://github.com/encode/httpx) for FRR/BIRD connections
:heavy_check_mark: Migrated front-end framework from Bulma to [Bootstrap 4](https://getbootstrap.com/) using a custom theme, for which most visual aspects are still completely customizable.
:heavy_check_mark: Front-end frameworks/dependencies are no longer bundled with hyperglass. [Yarn](https://yarnpkg.com/lang/en/) now handles package management, and [ParcelJS](https://parceljs.org/) now bundles and minifies all Javascript libraries, CSS frameworks and custom CSS, fonts, etc. making for a more consistent and controlable user experience.
:heavy_check_mark: Migrated config file language from TOML to [YAML](https://en.wikipedia.org/wiki/YAML).
:heavy_check_mark: [Pydantic](https://github.com/samuelcolvin/pydantic/) for config file modeling and validation. This will reduce, if not remove, the likelihood of accidentally misconfiguring hyperglass, your devices, or custom commands. It also allows for a significantly more sensible way of setting reasonable defaults, which now exist for all configuration variables, except for devices.
:heavy_check_mark: Ability to query multiple devices at once.
:heavy_check_mark: Custom commands are no longer NOS-specific. Command "profiles" can be arbitrarily created and associated with any device. This means that even if two different devices are running `cisco_ios`, one device can use one set of commands, and the other device can use a different set of commands.
:heavy_check_mark: Some other backend goodies like: A (configurable) global timeout, so if a device can't be reached for whatever reason, the user is not left to watch a loading bar. Faster SSH queries. *Way* faster queries when using an SSH proxy/tunnel. Drastically improved error handling with 100% customizable user-facing error messages. Front-end to back-end communication is now 100% JSON, which means hyperglass is also a looking glass API for your network, not just a GUI.
##### What I'm still working on:
:white_check_mark: VRF support. You'll be able to, per-device, enable queries to be VRF and AFI specific.
:white_check_mark: *Possibly* move to [Netdev](https://github.com/selfuryon/netdev) instead of Netmiko for SSH connection handling for performance gains.
:white_check_mark: Improved native Juniper support
:white_check_mark: Native Arista support
:white_check_mark: Native Huawei support
:white_check_mark: Improved reverse proxy docs, mainly for adding GZIP compression support for static files
:white_check_mark: Make Grafana dashboard available via Grafana's plugin marketplace
...and several other things that probably won't make it into 1.0 :)