bgpv1: Add `bgp/routes` API endpoint and `cilium bgp routes` CLI command #27182

rastislavs · 2023-08-01T09:43:54Z

Adds a new bgp/routes API endpoint and the cilium bgp routes CLI command implementation that can be used for retrieval of available/advertised routes from BGP Control Plane's RIBs.

Example usage:

Available ipv4 unicast routes:

$ cilium bgp routes available ipv4 unicast
VRouter   Prefix              NextHop   Age   Attrs
65001     10.0.0.0/24         0.0.0.0   21s   [{Origin: i} {Nexthop: 0.0.0.0}]   
65001     192.168.10.176/32   0.0.0.0   21s   [{Origin: i} {Nexthop: 0.0.0.0}]

ipv4 unicast routes advertised to the peer 172.0.0.1:

$ cilium bgp routes advertised ipv4 unicast peer 172.0.0.1
VRouter   Prefix              NextHop     Age      Attrs
65001     10.0.0.0/24         172.0.0.2   20m33s   [{Origin: i} {AsPath: 65001} {Nexthop: 172.0.0.2}]   
65001     192.168.10.176/32   172.0.0.2   20m33s   [{Origin: i} {AsPath: 65001} {Nexthop: 172.0.0.2}]

Available ipv4 unicast routes in virtual router with ASN 65001:

$ cilium bgp routes available ipv4 unicast vrouter 65001
VRouter   Prefix              NextHop   Age     Attrs
65001     10.0.0.0/24         0.0.0.0   24m7s   [{Origin: i} {Nexthop: 0.0.0.0}]   
65001     192.168.10.176/32   0.0.0.0   24m7s   [{Origin: i} {Nexthop: 0.0.0.0}]

Help:

$ cilium bgp routes -h
List routes in the BGP Control Plane's Routing Information Bases (RIBs)

Usage:
  cilium bgp routes <available | advertised> <afi> <safi> [vrouter <asn>] [peer|neighbor <address>] [flags]

Examples:
  Get all IPv4 unicast routes available:
    cilium bgp routes available ipv4 unicast

  Get all IPv6 unicast routes available for a specific vrouter:
    cilium bgp routes available ipv6 unicast vrouter 65001

  Get IPv4 unicast routes advertised to specific peer:
    cilium bgp routes advertised ipv4 unicast peer 10.0.0.1

Flags:
  -h, --help            help for routes
  -o, --output string   json| yaml| jsonpath='{}'

Global Flags:
      --config string   Config file (default is $HOME/.cilium.yaml)
  -D, --debug           Enable debug messages
  -H, --host string     URI to server-side API

rastislavs · 2023-08-01T12:55:49Z

/test

zacharysarah

@rastislavs One small wording nit, otherwise LGTM for docs

Documentation/configuration/api-restrictions-table.rst

dylandreimerink

Changes look good to me. It might be useful to add this command to the bugtool output so the info is available in sysdumps.

rastislavs · 2023-08-02T22:23:10Z

@dylandreimerink

It might be useful to add this command to the bugtool output so the info is available in sysdumps.

Added into bugtool (as well as the previously existing "cilium bgp peers" command). Realized that we need to properly handle cases when BGP Control Plane is not enabled, so fixed that in 04acf9f.

rastislavs · 2023-08-03T10:57:43Z

/test

zacharysarah

LGTM for docs

harsimran-pabla

Few comments, overall looks good. There are few follow ups, maybe tasks can be created for them

Extend this to cilium-cli
Paging of the result, as it can be very large (order of 10k).
Some optimization for later ( getting result concurrently from various vrouters - gobgp instances )

cilium/cmd/bgp_route_get.go

pkg/bgpv1/manager/manager.go

pkg/bgpv1/manager/manager_test.go

Add a new API endpoint bgp/routes to retrieve BGP CPlane's RIB from API. The actual implementation will be in subsequent commits. Signed-off-by: Yutaro Hayakawa <yutaro.hayakawa@isovalent.com> Co-authored-by: Rastislav Szabo <rastislav.szabo@isovalent.com>

Implement bgp/routes API by wiring-up API call with BGPRouterManager. Signed-off-by: Yutaro Hayakawa <yutaro.hayakawa@isovalent.com> Co-authored-by: Rastislav Szabo <rastislav.szabo@isovalent.com>

Implement `cilium bgp routes` command that retrieves routes from bgp/routes API and displays response. Also allow using "peer" and "neighbor" keyword interchangeably in bgp CLI (e.g. "cilium bgp peers" == "cilium bgp neighbors", "cilium bgp routes ... peer 172.0.0.1" == "cilium bgp routes ... neighbor 172.0.0.1"). Signed-off-by: Yutaro Hayakawa <yutaro.hayakawa@isovalent.com> Co-authored-by: Rastislav Szabo <rastislav.szabo@isovalent.com>

Fixes an issue with bgp/peers & bgp/routes API endpoint and cilium "bgp peers" & "bgp routes" CLI command when BGP Control Plane is disabled. Instead of returning an internal server error returns an specific error that can be properly handled in the CLI command code. Signed-off-by: Rastislav Szabo <rastislav.szabo@isovalent.com>

Includes "cilium bgp peers" & "cilium bgp routes" command outputs in the bugtool so that BGP info is available in sysdumps. Signed-off-by: Rastislav Szabo <rastislav.szabo@isovalent.com>

rastislavs · 2023-08-10T11:26:28Z

@harsimran-pabla

There are few follow ups, maybe tasks can be created for them

I have created an overarching follow-up task with potential enhancements: #27420

rastislavs · 2023-08-10T11:27:22Z

/test

harsimran-pabla

Thank you!! LGTM

nathanjsweet

A couple of nits for API and CLI.

api/v1/openapi.yaml

nathanjsweet

Approve for API and CLI

Due to the merge of cilium#27182 before cilium#27285 a bug was introduced in pkg/bgpv1/manager/manager_test.go. This commit fixes the issue. Signed-off-by: Louis DeLosSantos <louis.delos@isovalent.com>

Due to the merge of #27182 before #27285 a bug was introduced in pkg/bgpv1/manager/manager_test.go. This commit fixes the issue. Signed-off-by: Louis DeLosSantos <louis.delos@isovalent.com>

joestringer · 2023-08-31T16:50:35Z

We may want to mark this release-note/major as an improvement to the visibility and day 2 operations for BGP support in Cilium.

rastislavs · 2023-09-04T06:46:43Z

@joestringer

We may want to mark this release-note/major as an improvement to the visibility and day 2 operations for BGP support in Cilium.

makes sense, marked as release-note/major

rastislavs added kind/feature This introduces new functionality. release-note/minor This PR changes functionality that users may find relevant to operating Cilium. area/bgp Impacts the Border Gateway Protocol feature. labels Aug 1, 2023

rastislavs force-pushed the bgp-get-routes-api-cli branch 2 times, most recently from 3120b5c to 66b0dd2 Compare August 1, 2023 12:26

rastislavs self-assigned this Aug 1, 2023

rastislavs changed the title ~~bgpv1: Add bgp/routes API endpoint and cilium bgp routes CLI~~ bgpv1: Add bgp/routes API endpoint and cilium bgp routes CLI command Aug 1, 2023

rastislavs marked this pull request as ready for review August 1, 2023 13:54

rastislavs requested review from a team as code owners August 1, 2023 13:54

rastislavs requested review from dylandreimerink, learnitall, pippolo84, derailed and nathanjsweet August 1, 2023 13:54

zacharysarah requested changes Aug 2, 2023

View reviewed changes

Documentation/configuration/api-restrictions-table.rst Outdated Show resolved Hide resolved

dylandreimerink approved these changes Aug 2, 2023

View reviewed changes

rastislavs force-pushed the bgp-get-routes-api-cli branch from 66b0dd2 to 1ffd29b Compare August 2, 2023 21:51

rastislavs requested a review from a team as a code owner August 2, 2023 21:51

rastislavs force-pushed the bgp-get-routes-api-cli branch 4 times, most recently from a5b8191 to 428daf9 Compare August 2, 2023 22:17

rastislavs force-pushed the bgp-get-routes-api-cli branch from 428daf9 to 3443810 Compare August 2, 2023 22:26

dylandreimerink approved these changes Aug 3, 2023

View reviewed changes

maintainer-s-little-helper bot requested a review from zacharysarah August 3, 2023 12:04

learnitall removed their request for review August 4, 2023 18:16

zacharysarah approved these changes Aug 8, 2023

View reviewed changes

harsimran-pabla reviewed Aug 9, 2023

View reviewed changes

cilium/cmd/bgp_route_get.go Show resolved Hide resolved

pkg/bgpv1/manager/manager.go Show resolved Hide resolved

pkg/bgpv1/manager/manager_test.go Outdated Show resolved Hide resolved

rastislavs force-pushed the bgp-get-routes-api-cli branch from 3443810 to 46bc64f Compare August 10, 2023 09:45

YutaroHayakawa and others added 4 commits August 10, 2023 11:53

api,bgpv1: Implement bgp/routes API

1f52245

Implement bgp/routes API by wiring-up API call with BGPRouterManager. Signed-off-by: Yutaro Hayakawa <yutaro.hayakawa@isovalent.com> Co-authored-by: Rastislav Szabo <rastislav.szabo@isovalent.com>

bugtool: Add "cilium bgp peers" & "cilium bgp routes" command outputs

3875997

Includes "cilium bgp peers" & "cilium bgp routes" command outputs in the bugtool so that BGP info is available in sysdumps. Signed-off-by: Rastislav Szabo <rastislav.szabo@isovalent.com>

rastislavs force-pushed the bgp-get-routes-api-cli branch from 46bc64f to 3875997 Compare August 10, 2023 09:55

rastislavs mentioned this pull request Aug 10, 2023

Enhancements for the cilium bgp routes CLI command #27420

Open

5 tasks

harsimran-pabla approved these changes Aug 10, 2023

View reviewed changes

nathanjsweet requested changes Aug 10, 2023

View reviewed changes

api/v1/openapi.yaml Show resolved Hide resolved

nathanjsweet approved these changes Aug 10, 2023

View reviewed changes

nathanjsweet merged commit 964bbb5 into cilium:main Aug 10, 2023

joestringer mentioned this pull request Aug 31, 2023

Prepare for release v1.15.0-pre.0 #27853

Merged

rastislavs added release-note/major This PR introduces major new functionality to Cilium. and removed release-note/minor This PR changes functionality that users may find relevant to operating Cilium. labels Sep 4, 2023

danehans mentioned this pull request Oct 6, 2023

bgp: BGP Control Plane status in agent cli #22009

Closed

rastislavs mentioned this pull request Oct 10, 2023

Docs: Add BGP Advertised Path Attributes documentation #28482

Merged

rastislavs mentioned this pull request Dec 20, 2023

bgp: Add command for retrieving bgp routes cilium/cilium-cli#2201

Merged

rastislavs mentioned this pull request Jan 11, 2024

[v1.14] cilium bgp routes command backport #30205

Merged

bgpv1: Add bgp/routes API endpoint and cilium bgp routes CLI command #27182

bgpv1: Add bgp/routes API endpoint and cilium bgp routes CLI command #27182

Uh oh!

Conversation

rastislavs commented Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rastislavs commented Aug 1, 2023

Uh oh!

zacharysarah left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dylandreimerink left a comment

Choose a reason for hiding this comment

Uh oh!

rastislavs commented Aug 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rastislavs commented Aug 3, 2023

Uh oh!

zacharysarah left a comment

Choose a reason for hiding this comment

Uh oh!

harsimran-pabla left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rastislavs commented Aug 10, 2023

Uh oh!

rastislavs commented Aug 10, 2023

Uh oh!

harsimran-pabla left a comment

Choose a reason for hiding this comment

Uh oh!

nathanjsweet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nathanjsweet left a comment

Choose a reason for hiding this comment

Uh oh!

joestringer commented Aug 31, 2023

Uh oh!

rastislavs commented Sep 4, 2023

Uh oh!

Uh oh!

bgpv1: Add `bgp/routes` API endpoint and `cilium bgp routes` CLI command #27182

bgpv1: Add `bgp/routes` API endpoint and `cilium bgp routes` CLI command #27182

rastislavs commented Aug 1, 2023 •

edited

Loading

rastislavs commented Aug 2, 2023 •

edited

Loading