Skip to content

Commit 4966dd7

Browse files
bgp: Mark RouterManager.GetPeer and Router.GetPeerState as legacy
The current RouterManager.GetPeer and Router.GetPeerState API returns the API model directly. In the new CLI, we will rely on the new internal model we introduced in the previous commit. Since, we still need to keep the legacy output around for a while, mark it as legacy and keep it as is. We'll introduce a new implementation in the subsequent commits. Signed-off-by: Yutaro Hayakawa <[email protected]>
1 parent f27babd commit 4966dd7

12 files changed

Lines changed: 33 additions & 29 deletions

File tree

‎pkg/bgp/agent/routermgr.go‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,16 @@ type BGPRouterManager interface {
2020
// and the implementation will configure itself to apply this configuration.
2121
ReconcileInstances(ctx context.Context, bgpnc *v2.CiliumBGPNodeConfig, ciliumNode *v2.CiliumNode) error
2222

23-
// GetPeers fetches BGP peering state from underlying routing daemon.
23+
// GetPeersLegacy fetches BGP peering state from underlying routing
24+
// daemon.
2425
//
25-
// List of all peers will be returned and if there are multiple instances of
26-
// BGP daemon running locally, then peers can be differentiated based on
27-
// local AS number.
28-
GetPeers(ctx context.Context) ([]*models.BgpPeer, error)
26+
// List of all peers will be returned and if there are multiple
27+
// instances of BGP daemon running locally, then peers can be
28+
// differentiated based on local AS number.
29+
//
30+
// This is a legacy method used by the REST API and will be replaced in
31+
// the future.
32+
GetPeersLegacy(ctx context.Context) ([]*models.BgpPeer, error)
2933

3034
// GetRoutes fetches BGP routes from underlying routing daemon's RIBs.
3135
GetRoutes(ctx context.Context, params restapi.GetBgpRoutesParams) ([]*models.BgpRoute, error)

‎pkg/bgp/api/get_peer.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func (h *getPeerHandler) Handle(params restapi.GetBgpPeersParams) middleware.Res
3232
if h.controller == nil {
3333
return api.Error(http.StatusNotImplemented, agent.ErrBGPControlPlaneDisabled)
3434
}
35-
peers, err := h.controller.BGPMgr.GetPeers(params.HTTPRequest.Context())
35+
peers, err := h.controller.BGPMgr.GetPeersLegacy(params.HTTPRequest.Context())
3636
if err != nil {
3737
return api.Error(http.StatusInternalServerError, fmt.Errorf("failed to get peers: %w", err))
3838
}

‎pkg/bgp/gobgp/state.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ func (g *GoBGPServer) GetBGP(ctx context.Context) (types.GetBGPResponse, error)
4343
}, nil
4444
}
4545

46-
// GetPeerState invokes goBGP ListPeer API to get current peering state.
47-
func (g *GoBGPServer) GetPeerState(ctx context.Context) (types.GetPeerStateResponse, error) {
46+
// GetPeerStateLegacy invokes goBGP ListPeer API to get current peering state.
47+
func (g *GoBGPServer) GetPeerStateLegacy(ctx context.Context) (types.GetPeerStateLegacyResponse, error) {
4848
var data []*models.BgpPeer
4949
fn := func(peer *gobgp.Peer) {
5050
if peer == nil {
@@ -132,10 +132,10 @@ func (g *GoBGPServer) GetPeerState(ctx context.Context) (types.GetPeerStateRespo
132132
// advertised routes.
133133
err := g.server.ListPeer(ctx, &gobgp.ListPeerRequest{EnableAdvertised: true}, fn)
134134
if err != nil {
135-
return types.GetPeerStateResponse{}, err
135+
return types.GetPeerStateLegacyResponse{}, err
136136
}
137137

138-
return types.GetPeerStateResponse{
138+
return types.GetPeerStateLegacyResponse{
139139
Peers: data,
140140
}, nil
141141
}

‎pkg/bgp/gobgp/state_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ func TestGetPeerState(t *testing.T) {
321321
}
322322
}
323323

324-
res, err := testSC.GetPeerState(context.Background())
324+
res, err := testSC.GetPeerStateLegacy(context.Background())
325325
require.NoError(t, err)
326326

327327
// validate neighbors count
@@ -341,7 +341,7 @@ func TestGetPeerState(t *testing.T) {
341341
}
342342
}
343343

344-
res, err = testSC.GetPeerState(context.Background())
344+
res, err = testSC.GetPeerStateLegacy(context.Background())
345345
require.NoError(t, err)
346346

347347
// validate peers

‎pkg/bgp/manager/manager.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ func (m *BGPRouterManager) reconcileStateWithRetry(ctx context.Context) error {
214214
return wait.ExponentialBackoffWithContext(ctx, bo, retryFn)
215215
}
216216

217-
// GetPeers gets peering state from previously initialized bgp instances.
218-
func (m *BGPRouterManager) GetPeers(ctx context.Context) ([]*models.BgpPeer, error) {
217+
// GetPeersLegacy gets peering state from previously initialized bgp instances.
218+
func (m *BGPRouterManager) GetPeersLegacy(ctx context.Context) ([]*models.BgpPeer, error) {
219219
m.RLock()
220220
defer m.RUnlock()
221221

@@ -225,7 +225,7 @@ func (m *BGPRouterManager) GetPeers(ctx context.Context) ([]*models.BgpPeer, err
225225

226226
var res []*models.BgpPeer
227227
for _, i := range m.BGPInstances {
228-
getPeerResp, err := i.Router.GetPeerState(ctx)
228+
getPeerResp, err := i.Router.GetPeerStateLegacy(ctx)
229229
if err != nil {
230230
return nil, err
231231
}
@@ -266,7 +266,7 @@ func (m *BGPRouterManager) GetRoutes(ctx context.Context, params restapi.GetBgpR
266266
}
267267
if allPeers {
268268
// get routes for each peer of the server
269-
getPeerResp, err := i.Router.GetPeerState(ctx)
269+
getPeerResp, err := i.Router.GetPeerStateLegacy(ctx)
270270
if err != nil {
271271
return nil, err
272272
}

‎pkg/bgp/manager/reconciler/crd_status.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ func (r *StatusReconciler) getInstanceStatus(ctx context.Context, instance *inst
355355
}
356356

357357
// get peer status
358-
peers, err := instance.Router.GetPeerState(ctx)
358+
peers, err := instance.Router.GetPeerStateLegacy(ctx)
359359
if err != nil {
360360
return nil, err
361361
}

‎pkg/bgp/manager/reconciler/neighbor_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -534,7 +534,7 @@ func setupNeighbors(t *testing.T, peers []PeerData) (NeighborReconcilerIn, *v2.C
534534
}
535535

536536
func getRunningPeers(req *require.Assertions, instance *instance.BGPInstance) []PeerData {
537-
getPeerResp, err := instance.Router.GetPeerState(context.Background())
537+
getPeerResp, err := instance.Router.GetPeerStateLegacy(context.Background())
538538
req.NoError(err)
539539

540540
var runningPeers []PeerData

‎pkg/bgp/metrics/metrics.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ func (c *collector) Collect(ch chan<- prometheus.Metric) {
8383
// revisit this timeout when the metrics collection starts to involve a
8484
// network communication.
8585
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
86-
peers, err := c.in.RouterManager.GetPeers(ctx)
86+
peers, err := c.in.RouterManager.GetPeersLegacy(ctx)
8787
cancel()
8888
if err != nil {
8989
c.in.Logger.Error("Failed to retrieve BGP peer information. Metrics is not collected.", logfields.Error, err)

‎pkg/bgp/mock/mocks.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var _ agent.BGPRouterManager = (*MockBGPRouterManager)(nil)
3737

3838
type MockBGPRouterManager struct {
3939
ReconcileInstances_ func(ctx context.Context, bgpnc *v2.CiliumBGPNodeConfig, ciliumNode *v2.CiliumNode) error
40-
GetPeers_ func(ctx context.Context) ([]*models.BgpPeer, error)
40+
GetPeersLegacy_ func(ctx context.Context) ([]*models.BgpPeer, error)
4141
GetRoutes_ func(ctx context.Context, params restapi.GetBgpRoutesParams) ([]*models.BgpRoute, error)
4242
GetRoutePolicies_ func(ctx context.Context, params restapi.GetBgpRoutePoliciesParams) ([]*models.BgpRoutePolicy, error)
4343
Stop_ func(cell.HookContext) error
@@ -47,8 +47,8 @@ func (m *MockBGPRouterManager) ReconcileInstances(ctx context.Context, bgpnc *v2
4747
return m.ReconcileInstances_(ctx, bgpnc, ciliumNode)
4848
}
4949

50-
func (m *MockBGPRouterManager) GetPeers(ctx context.Context) ([]*models.BgpPeer, error) {
51-
return m.GetPeers_(ctx)
50+
func (m *MockBGPRouterManager) GetPeersLegacy(ctx context.Context) ([]*models.BgpPeer, error) {
51+
return m.GetPeersLegacy_(ctx)
5252
}
5353

5454
func (m *MockBGPRouterManager) GetRoutes(ctx context.Context, params restapi.GetBgpRoutesParams) ([]*models.BgpRoute, error) {

‎pkg/bgp/test/commands/bgp.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ func BGPPPeersCmd(bgpMgr agent.BGPRouterManager) script.Cmd {
4949
defer f.Close()
5050
}
5151

52-
peers, err := bgpMgr.GetPeers(s.Context())
52+
peers, err := bgpMgr.GetPeersLegacy(s.Context())
5353
if err != nil {
5454
return "", "", err
5555
}

0 commit comments

Comments
 (0)