Allow EVPN Type 5 overlay gateway injection by lance0 · Pull Request #231 · lance0/rustbgpd

lance0 · 2026-05-22T13:44:03Z

Summary

add optional AddEvpnRoute Type 5 gateway field for controller-supplied overlay-index Gateway Address injection
expose --gateway on rustbgpctl evpn add-ip-prefix while preserving the existing interface-less default
keep unsupported shapes fail-closed: non-zero ESI, non-zero Type 5 Ethernet Tag, gateway on Type 2/3, and family mismatches
update API, enablement, roadmap, and changelog docs

Verification

cargo test -p rustbgpd-api injection_service -- --nocapture
cargo test -p rustbgpctl evpn -- --nocapture
cargo test -p rustbgpctl test_parse_evpn_add_ip_prefix -- --nocapture
cargo fmt --all -- --check
cargo clippy --workspace --all-targets -- -D warnings
git diff --check

Notes

This is the non-#210 EVPN follow-through slice from the local sprint board. DeleteEvpnRoute remains keyed by RD, Ethernet Tag, and prefix/prefix length because the current local EVPN Type 5 route key excludes gateway; native local overlay-index origination remains future work.

Copilot

Pull request overview

Enables controller-supplied EVPN Type 5 (IP Prefix) injection with an optional non-zero Gateway Address (overlay-index testing), exposing the new field through the gRPC API and rustbgpctl, and updating docs/roadmap/changelog to reflect the expanded supported shape while still failing closed on unsupported combinations.

Changes:

Extend AddEvpnRouteRequest with an optional gateway field for Type 5 and enforce additional validation in the injection service.
Add --gateway to rustbgpctl evpn add-ip-prefix, preserving the default interface-less (empty gateway) behavior.
Update documentation (API, enablement, roadmap) and changelog entries to describe overlay-index gateway injection support.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
ROADMAP.md	Notes controller-injected Type 5 gateway support in overlay-index IRB roadmap items.
proto/rustbgpd.proto	Adds `gateway` to `AddEvpnRouteRequest` and updates API comments for Type 5 behavior.
docs/evpn-enablement.md	Documents that Type 5 injection supports both interface-less and overlay-index gateway shapes.
docs/API.md	Updates public API documentation/examples to describe the new Type 5 gateway field and semantics.
crates/cli/src/main.rs	Adds `--gateway` flag plumbing for `evpn add-ip-prefix` and updates CLI parsing tests.
crates/cli/src/commands/evpn.rs	Threads optional gateway into `AddEvpnRouteRequest` for Type 5; keeps Type 2/3 gateway empty.
crates/api/src/injection_service.rs	Implements gateway parsing/validation and constructs Type 5 routes with either zero or provided gateway.
CHANGELOG.md	Announces EVPN Type 5 overlay-index gateway injection feature.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+        return Err(Status::invalid_argument(
+            "gateway must not be zero; omit gateway for interface-less Type 5",
+        ));
+    }


+  // Optional Gateway IP (Type 5 only). Empty encodes the interface-less
+  // zero gateway for the prefix family; non-empty enables overlay-index
+  // Type 5 injection and must use the same address family as `prefix`
+  // and `next_hop`.


Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

+    let gateway: IpAddr = gateway_str
+        .parse()
+        .map_err(|e| Status::invalid_argument(format!("invalid Type 5 gateway: {e}")))?;
+    if gateway.is_unspecified() {
+        return Err(Status::invalid_argument(
+            "gateway must not be zero; omit gateway for interface-less Type 5",
+        ));
+    }
+    if gateway.is_multicast() {
+        return Err(Status::invalid_argument(
+            "Type 5 gateway must be a unicast address",
+        ));
+    }


  labels and the `IpVrfState.remote_prefix_drop_counts` API / CLI field, so
  recursive failures are visible without prefix/MAC cardinality in metrics or
-  status output.
+  status output. Controller injection can now synthesize non-zero Gateway
+  Address Type 5 routes for targeted overlay-index testing without enabling
+  native local overlay-index origination.


Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.

A Type 5 overlay-index Gateway Address identifies a unicast host gateway, so reject multicast values (mirroring parse_unicast_nexthop) rather than only zero. Document in the proto / API docs that a set gateway must be a non-zero unicast address; omit it for interface-less Type 5. Add a multicast-gateway rejection test.

… note - parse_type5_gateway now rejects the IPv4 limited broadcast address in addition to zero/multicast, matching the unicast contract in the docs. - Remove the controller-injection sentence appended to the v0.18.0 "Shipped pieces" overlay-index bullet; the capability is already documented in the Gate 6 controller-injection section.

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

    if ethernet_tag != 0 {
        return Err(CliError::Argument(
-            "EVPN Type 5 pure/interface-less injection requires --ethernet-tag 0".into(),
+            "EVPN Type 5 injection requires --ethernet-tag 0".into(),


validate_ip_prefix_ethernet_tag backs both add-ip-prefix and delete-ip-prefix, so the "injection" wording was misleading on the delete path. Use a route-type-neutral message.

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

+    let is_broadcast = matches!(gateway, IpAddr::V4(v4) if v4.is_broadcast());
+    if gateway.is_multicast() || is_broadcast {
+        return Err(Status::invalid_argument(
+            "Type 5 gateway must be a unicast address",
+        ));
+    }


lance0 requested a review from Copilot May 22, 2026 13:44

Copilot started reviewing on behalf of lance0 May 22, 2026 13:44 View session

Copilot AI reviewed May 22, 2026

View reviewed changes

lance0 mentioned this pull request May 22, 2026

Extend M45 EVPN Type 5 overlay gateway smoke #232

Merged

lance0 requested a review from Copilot May 22, 2026 15:37

Copilot started reviewing on behalf of lance0 May 22, 2026 15:37 View session

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:40 — with GitHub Actions Inactive

Copilot AI reviewed May 22, 2026

View reviewed changes

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:43 — with GitHub Actions Inactive

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:44 — with GitHub Actions Inactive

lance0 requested a review from Copilot May 22, 2026 15:44

Copilot started reviewing on behalf of lance0 May 22, 2026 15:44 View session

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:45 — with GitHub Actions Inactive

Copilot AI reviewed May 22, 2026

View reviewed changes

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:47 — with GitHub Actions Inactive

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:48 — with GitHub Actions Inactive

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:49 — with GitHub Actions Inactive

lance0 added 3 commits May 22, 2026 11:50

Add EVPN Type 5 overlay gateway injection

4e6ef0f

lance0 requested a review from Copilot May 22, 2026 15:51

lance0 force-pushed the feat/evpn-type5-overlay-gateway-injection branch from f87e441 to 1c8122b Compare May 22, 2026 15:51

Copilot started reviewing on behalf of lance0 May 22, 2026 15:51 View session

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:54 — with GitHub Actions Inactive

Copilot AI reviewed May 22, 2026

View reviewed changes

Comment thread crates/cli/src/commands/evpn.rs Outdated

if ethernet_tag != 0 {

return Err(CliError::Argument(

"EVPN Type 5 pure/interface-less injection requires --ethernet-tag 0".into(),

"EVPN Type 5 injection requires --ethernet-tag 0".into(),

cli: neutral --ethernet-tag error shared by add/delete ip-prefix

dc17007

validate_ip_prefix_ethernet_tag backs both add-ip-prefix and delete-ip-prefix, so the "injection" wording was misleading on the delete path. Use a route-type-neutral message.

lance0 requested a review from Copilot May 22, 2026 15:56

Copilot started reviewing on behalf of lance0 May 22, 2026 15:56 View session

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 15:59 — with GitHub Actions Inactive

Copilot AI reviewed May 22, 2026

View reviewed changes

Comment thread crates/api/src/injection_service.rs

Comment on lines +131 to +136

let is_broadcast = matches!(gateway, IpAddr::V4(v4) if v4.is_broadcast());

if gateway.is_multicast() || is_broadcast {

return Err(Status::invalid_argument(

"Type 5 gateway must be a unicast address",

));

}

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 16:02 — with GitHub Actions Inactive

lance0 temporarily deployed to kernel-dataplane-auto May 22, 2026 16:03 — with GitHub Actions Inactive

lance0 merged commit 16ddbc7 into main May 22, 2026
36 checks passed

lance0 deleted the feat/evpn-type5-overlay-gateway-injection branch May 22, 2026 16:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow EVPN Type 5 overlay gateway injection#231

Allow EVPN Type 5 overlay gateway injection#231
lance0 merged 4 commits into
mainfrom
feat/evpn-type5-overlay-gateway-injection

lance0 commented May 22, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

lance0 commented May 22, 2026

Summary

Verification

Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants