diff --git a/CHANGELOG.md b/CHANGELOG.md index e6e5299..1cf3964 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,9 @@ All notable changes to this project will be documented in this file. -## v0.7.0-beta.6 - 2024-04-29 +## v0.7.0 - 2024-06-18 -### [New!] NATS notification +### [NEW] NATS notification Added new-file notification by publishing newly indexed BGP MRT file meta information in JSON format to user-specified NATS server. @@ -45,7 +45,7 @@ Options: -V, --version Print version ``` -### [New!] `bgpkit-broker doctor` subcommand +### [NEW] `bgpkit-broker doctor` subcommand Added `bgpkit-broker doctor` subcommand that checks the broker instance status and missing collectors. @@ -79,17 +79,14 @@ missing the following collectors: | routeviews | iraq-ixp.bgw | Iraq | 2024-04-13 00:01:00 | http://archive.routeviews.org/iraq-ixp.bgw/bgpdata | ``` -## v0.7.0-beta.5 - 2024-01-29 +### [NEW] Heartbeat URL support -### Breaking changes - -- switch to `rustls` as the default TLS backend - -## v0.7.0-beta.4 - 2024-01-18 +If `BGPKIT_BROKER_HEARTBEAT_URL` environment is set, when running the `bgpkit-broker serve` subcommand, the instance +will periodically send a GET request to the configured heartbeat URL. -### CLI addition +### [NEW] `bgpkit-broker latest` subcommand -- added `latest` subcommand to CLI to display latest MRT files for all collectors +Added `latest` subcommand to CLI to display latest MRT files for all collectors. ### Developer experience improvements @@ -102,6 +99,10 @@ An array of `BrokerItem`s can be sorted with the following order: 2. RIB before updates 3. then alphabetical order on collector ID (route-views before rrc) +### Breaking changes + +- switch to `rustls` as the default TLS backend + ## V0.6.1 ### What's Changed diff --git a/Cargo.toml b/Cargo.toml index df83767..db23b66 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bgpkit-broker" -version = "0.7.0-beta.6" +version = "0.7.0" edition = "2021" authors = ["Mingwei Zhang "] readme = "README.md" diff --git a/README.md b/README.md index eb12c20..d99f2fb 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ from [RIPE RIS][ripe-ris] and [RouteViews][route-views]. This Rust library provides SDK access to the BGPKIT Broker API as well as a command-line tool to start a self-hosted broker instance. -Current BGPKIT Broker API is available at . +The current BGPKIT Broker API is available at . BGPKIT Broker is used in production at [Cloudflare Radar][radar] powering its [routing page][routing] and projects like [BGP hijack detection]() @@ -56,7 +56,7 @@ and [route leak detection](https://blog.cloudflare.com/route-leak-detection-with Add the following dependency line to your project's `Cargo.toml` file: ```yaml -bgpkit-broker = "0.7.0-beta.6" +bgpkit-broker = "0.7.0" ``` ### Example @@ -91,7 +91,7 @@ Broker instance with ease. ### Install -Install with `cargo install bgpkit-broker@0.7.0-beta.5 --features cli` or check out the main branch and +Install with `cargo install bgpkit-broker@0.7.0 --features cli` or check out the main branch and run `cargo install --path . --features cli`. If you are on a macOS environment, you can also use homebrew to install the pre-compiled binary (universal): @@ -305,7 +305,7 @@ missing the following collectors: ## Data Provider -If you have publicly available data and want to be indexed BGPKIT Broker service, please send us an email at +If you have publicly available data and want to be indexed BGPKIT Broker service, please email us at data@bgpkit.com. Our back-end service is designed to be flexible and should be able to adapt to most data archiving approaches.