checktheroads-hyperglass/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.0.0-beta60 - 2020-10-10

Fixed

• #90: Fix a typing error that caused ping & traceroute queries to fail for certain devices.

Added

• #82: Add support for Redis password authentication. Authentication can be configured in the following manner:

# hyperglass.yaml
cache:
  password: examplepassword

This would correspond with the following stanza in the Redis configuration file:

requirepass examplepassword

1.0.0-beta59 - 2020-10-05

Added

• Native Mikrotik support.
• hyperglass clear-cache command for easy manual clearing of the Redis cache.

Changed

• Improve output parsing scalability - parsers can now be defined on a per-NOS basis regardless of whether or not structured-data is used.
• Restructure model locations & importing to remove some complexities.

1.0.0-beta58 - 2020-09-28

Changed

• #79: Run the UI build on startup & clarify docs.
• Removed all f-strings from log messages.
• Migrate icon library to @meronex/icons for better tree-shaking.
• Improve console (stdout) logging
• Fix file logging format

Fixed

• #74: Fix UI build failures caused by .alias.js.
• #75: Fix whitespace stripping of query target.
• #77: Allow dashes in FQDN validation pattern.
• #83: Fix lack of support for protocol-nh field in Juniper XML BGP table.

1.0.0-beta57 - 2020-07-30

BREAKING CHANGE

If you use hyperglass-agent, you must upgrade your version of hyperglass-agent to 0.1.6 or later. If using hyperglass-agent with SSL, this release will require you to re-generate & re-send your SSL certificates to hyperglass:

$ hyperglass-agent certificate
$ hyperglass-agent send-certificate

Changed

• Verify a device's address is either an IPv4 or IPv6 address, or a resolvable hostname.
• Devices using hyperglass-agent (FRR, BIRD) no longer need to use a DNS-resolvable hostname in the address: field, as long as the certificate has been generated by hyperglass-agent, and the proper IP addresses were selected during the prompts to generate the certificate. If using your own certificate and you want to connect to hyperglass-agent via an IP address instead of a hostname, you need to ensure the IP address of hyperglass-agent is listed as a Subject Alternative Name in the certificate extensions.
• Refactored device, query, proxy models to no longer scrub unsupported characters from the device name for the purposes of Python class attribute accessing.
• Updated hyperglass-agent docs.

1.0.0-beta56 - 2020-07-28

Changed

• Improved Gunicorn address formatting.
• Improved Redis connection error handling.

Fixed

• #56: Fix a silent Redis connection error if the Redis server was anything other than localhost, preventing hyperglass from starting.

1.0.0-beta55 - 2020-07-27

Changed

• Removed JS favicon build process in favor of native Python implementation (favicons)

1.0.0-beta54 - 2020-07-25

Fixed

• Queries to hyperglass-agent devices failed due to the error AttributeError: 'AgentConnection' object has no attribute 'collect'

1.0.0-beta53 - 2020-07-23

Added

• BREAKING CHANGE: Scrapli is now used for SSH connectivity to Cisco IOS, Cisco IOS-XE, Cisco IOS-XR, Cisco NX-OS Juniper Junos, and Arista EOS, which should improve the speed at which output is gathered from devices. As of this release, Cisco IOS/IOS-XE and Juniper Junos have been directly tested and worked without issue. However, if you discover any anomalies with any of these operating systems, please open an issue.

Changed

• Refactor of SSH & HTTPS command execution to enable pluggable underlying driver capabilities.
• Remove aiofile dependency by removing unnecessary asyncio file operations in the UI build process.
• Added scrapli[asyncssh] dependency for Scrapli driver support.

Fixed

• UI: Error messages couldn't be copied with the copy button

1.0.0-beta52 - 2020-07-19

Added

• API route /api/info, which displays general system information such as the name of the organization and version of hyperglass.
• API docs configuration parameters for the /api/info route.
• #63: Minimum RAM requirements.
• hyperglass system-info CLI command to gather system CPU, Memory, Disk, Python Version, hyperglass Version, & OS info. Note: this information is only gathered if you run the command, and even then, is printed to the console and not otherwise shared or exported.

Changed

• Updated docs dependencies.
• Improved YAML alias & anchor docs.
• #55: Removed YAML alias & anchors from default examples to avoid confusion.

Fixed

• API docs logo URL now displays correctly.
• #62: Added epel-release to CentOS installation instructions.
• #59: Fixed copy output for Juniper devices on non-table output query types.
• hyperglass-agent #6: Fixed hyperglass-agent documentation issues.
• Improve command customization docs.
• #61: Fixed copy output for table data. Output is now a bulleted list of parsed data.

1.0.0-beta51 - 2020-07-13

Changed

• Improved config import process & error handling.
• Improved logging initialization so that noisy logs aren't generated on startup unless debugging is enabled.

Fixed

• #54: A Junos parsing error caused routes with no communities to raise an error.
• Pre-validated config files are no longer logged on startup unless debugging is enabled.

1.0.0-beta50 - 2020-07-12

Added

• Synchronous API for Redis caching.
• New redis-py dependency for synchronous Redis communication.

Changed

• Improved cache type conversion when reading cached data.
• External data via bgp.tools is now gathered via their bulk mode API.
• External data via bgp.tools is now cached via Redis to reduce external traffic and improve performance.
• RPKI validation via Cloudflare is now cached via Redis to reduce external traffic and improve performance.
• Update Python dependencies.

Fixed

• #54: A Junos structured/table output parsing error caused routes with multiple next-hops to raise an error.
• RPKI validation no longer occurs twice (once on serialization of the output, once on validation of the API response).

1.0.0-beta49 - 2020-07-05

Changed

• Update UI dependencies
• Removed react-textfit in favor of responsive font sizes and line breaking
• Refactor & clean up React components

Fixed

• Route lookups for private (RFC 1918) addresses failed due to an unnecessary lookup to bgp.tools

1.0.0-beta48 - 2020-07-04

Added

• New NOS: VyOS. See docs for important caveats.

Fixed

• UI: If the logo width parameter was set to ~ 50% and the title_mode was set to logo_subtitle, the subtitle would appear next to the logo instead of underneath.
• When copying the opengraph image, the copied image was not deleted.
• Default traceroute help link now actually points to the new docs site.

1.0.0-beta47 - 2020-07-04

Added

• Opengraph images are now automatically generated in the correct format from any valid image file.
• Better color mode toggle icons (they now match hyperglass.io).

Changed

• Improved SEO & Accessibility for UI.
• Default traceroute help link now points to new docs site.
• Slightly different default black & white colors (they now match hyperglass.io).
• Various docs site improvements

Fixed

• Remove platform.linux_distribution() which was removed in Python 3.8
• Width of page is no longer askew when logo_subtitle is set as the title_mode
• Generated favicon manifest files now go to the correct directory.
• Various docs site fixes

1.0.0-beta46 - 2020-06-28

Added

• Support for hyperglass-agent 0.1.5

1.0.0-beta45 - 2020-06-27

Changed

• Removed RIPEStat for external data gathering, switched to bgp.tools

Fixed

• Webhook construction bugs that caused webhooks not to send
• Empty response handling for table output

1.0.0-beta44 - 2020-06-26

Added

• Support for Microsoft Teams webhook

Fixed

• If webhooks were enabled, a hung test connection to RIPEStat would cause the query to time out

1.0.0-beta43 - 2020-06-22

Fixed

• Logo path handling in UI

1.0.0-beta42 - 2020-06-21

Added

• Automatic favicon generation

Changed

• BREAKING CHANGE: The logo section now requires the full path for logo files. See the docs for details.