Pass NetworkStateUpdater to Cluster API Server to retrieve current IPAM state for network introspection

Add UpdateNetworkState() method to NetworkAllocator interface

Signed-off-by: Andrey Epifanov <[email protected]>

Author: aepifanov

manager/allocator/allocator.go

@@ -229,3 +229,7 @@ nextVoter:
 
 	return true
 }
+
+func (a *Allocator) UpdateNetworkState(net *api.Network) error {
+	return a.nwkAllocator.UpdateNetworkState(net)
+}

manager/allocator/networkallocator/inert.go

@@ -127,3 +127,7 @@ func (Inert) IsServiceAllocated(s *api.Service, flags ...func(*ServiceAllocation
 func (Inert) IsTaskAllocated(t *api.Task) bool {
 	return (Inert{}).AllocateTask(t) == nil
 }
+
+func (Inert) UpdateNetworkState(*api.Network) error {
+	return nil
+}

manager/allocator/networkallocator/networkallocator.go

@@ -85,6 +85,14 @@ type NetworkAllocator interface {
 
 	// IsAttachmentAllocated If lb endpoint is allocated on the node
 	IsAttachmentAllocated(node *api.Node, networkAttachment *api.NetworkAttachment) bool
+
+	// UpdateNetworkState updates the network state
+	UpdateNetworkState(network *api.Network) error
+}
+
+// NetworkStateUpdater is an interface for updating the network state in the store.
+type NetworkStateUpdater interface {
+	UpdateNetworkState(*api.Network) error
 }
 
 // Config is used to store network related cluster config in the Manager.

manager/controlapi/network.go

@@ -148,6 +148,11 @@ func (s *Server) GetNetwork(ctx context.Context, request *api.GetNetworkRequest)
 	if n == nil {
 		return nil, status.Errorf(codes.NotFound, "network %s not found", request.NetworkID)
 	}
+
+	if err := s.netStateUpdater.UpdateNetworkState(n); err != nil {
+		return nil, status.Errorf(codes.NotFound, "failed to get IPAM data for network %s: %v", request.NetworkID, err)
+	}
+
 	return &api.GetNetworkResponse{
 		Network: n,
 	}, nil
@@ -292,6 +297,12 @@ func (s *Server) ListNetworks(ctx context.Context, request *api.ListNetworksRequ
 		)
 	}
 
+	for _, n := range networks {
+		if err := s.netStateUpdater.UpdateNetworkState(n); err != nil {
+			return nil, err
+		}
+	}
+
 	return &api.ListNetworksResponse{
 		Networks: networks,
 	}, nil

manager/controlapi/server.go

@@ -16,23 +16,28 @@ var (
 
 // Server is the Cluster API gRPC server.
 type Server struct {
-	store          *store.MemoryStore
-	raft           *raft.Node
-	securityConfig *ca.SecurityConfig
-	netvalidator   networkallocator.DriverValidator
-	dr             *drivers.DriverProvider
+	store           *store.MemoryStore
+	raft            *raft.Node
+	securityConfig  *ca.SecurityConfig
+	netvalidator    networkallocator.DriverValidator
+	dr              *drivers.DriverProvider
+	netStateUpdater networkallocator.NetworkStateUpdater
 }
 
 // NewServer creates a Cluster API server.
-func NewServer(store *store.MemoryStore, raft *raft.Node, securityConfig *ca.SecurityConfig, nv networkallocator.DriverValidator, dr *drivers.DriverProvider) *Server {
+func NewServer(store *store.MemoryStore, raft *raft.Node, securityConfig *ca.SecurityConfig, nv networkallocator.DriverValidator, dr *drivers.DriverProvider, nsu networkallocator.NetworkStateUpdater) *Server {
 	if nv == nil {
 		nv = networkallocator.InertProvider{}
 	}
+	if nsu == nil {
+		nsu = networkallocator.Inert{}
+	}
 	return &Server{
-		store:          store,
-		dr:             dr,
-		raft:           raft,
-		securityConfig: securityConfig,
-		netvalidator:   nv,
+		store:           store,
+		dr:              dr,
+		raft:            raft,
+		securityConfig:  securityConfig,
+		netvalidator:    nv,
+		netStateUpdater: nsu,
 	}
 }

manager/controlapi/server_test.go

@@ -47,7 +47,7 @@ func newTestServer(t *testing.T) *testServer {
 	ts.Store = store.NewMemoryStore(&stateutils.MockProposer{})
 	assert.NotNil(t, ts.Store)
 
-	ts.Server = NewServer(ts.Store, nil, securityConfig, nil, nil)
+	ts.Server = NewServer(ts.Store, nil, securityConfig, nil, nil, nil)
 	assert.NotNil(t, ts.Server)
 
 	temp, err := os.CreateTemp("", "test-socket")

manager/manager.go

@@ -435,6 +435,10 @@ func (m *Manager) Addr() string {
 	return m.config.RemoteAPI.ListenAddr
 }
 
+func (m *Manager) UpdateNetworkState(net *api.Network) error {
+	return m.allocator.UpdateNetworkState(net)
+}
+
 // Run starts all manager sub-systems and the gRPC server at the configured
 // address.
 // The call never returns unless an error occurs or `Stop()` is called.
@@ -472,7 +476,14 @@ func (m *Manager) Run(parent context.Context) error {
 		return err
 	}
 
-	baseControlAPI := controlapi.NewServer(m.raftNode.MemoryStore(), m.raftNode, m.config.SecurityConfig, m.config.networkProvider(), drivers.New(m.config.PluginGetter))
+	networkProvider := m.config.networkProvider()
+	baseControlAPI := controlapi.NewServer(
+		m.raftNode.MemoryStore(),
+		m.raftNode,
+		m.config.SecurityConfig,
+		networkProvider,
+		drivers.New(m.config.PluginGetter),
+		m)
 	baseResourceAPI := resourceapi.New(m.raftNode.MemoryStore())
 	healthServer := health.NewHealthServer()
 	localHealthServer := health.NewHealthServer()

manager/orchestrator/jobs/orchestrator_controlapi_integration_test.go

@@ -54,7 +54,7 @@ var _ = Describe("Integration between the controlapi and jobs orchestrator", fun
 		// but it's unexported. in any case, re-writing it in ginkgo isn't
 		// unwarranted.
 		s = store.NewMemoryStore(&stateutils.MockProposer{})
-		server = controlapi.NewServer(s, nil, nil, nil, nil)
+		server = controlapi.NewServer(s, nil, nil, nil, nil, nil)
 
 		// we need a temporary unix socket to server on
 		temp, err := os.CreateTemp("", "test-socket")

swarmd/go.work.sum

@@ -257,6 +257,8 @@ github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802 h1:1BDTz0u9nC3//pOC
 github.com/Microsoft/hcsshim v0.9.8 h1:lf7xxK2+Ikbj9sVf2QZsouGjRjEp2STj1yDHgoVtU5k=
 github.com/Microsoft/hcsshim v0.9.8/go.mod h1:7pLA8lDk46WKDWlVsENo92gC0XFa8rbKfyFRBqxEbCc=
 github.com/OneOfOne/xxhash v1.2.2 h1:KMrpdQIwFcEqXDklaen+P1axHaj9BSKzvpUUfnHldSE=
+github.com/akutz/gosync v0.1.0/go.mod h1:I8I4aiqJI1nqaeYOOB1WS+CgRJVVPqhct9Y4njywM84=
+github.com/akutz/memconn v0.1.0/go.mod h1:Jo8rI7m0NieZyLI5e2CDlRdRqRRB4S7Xp77ukDjH+Fw=
 github.com/alecthomas/kingpin/v2 v2.3.1 h1:ANLJcKmQm4nIaog7xdr/id6FM6zm5hHnfZrvtKPxqGg=
 github.com/alecthomas/kingpin/v2 v2.3.1/go.mod h1:oYL5vtsvEHZGHxU7DMp32Dvx+qL+ptGn6lWaot2vCNE=
 github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751 h1:JYp7IbQjafoB+tBA3gMyHYHrpOtNuDiK/uB5uXxq5wM=
@@ -329,6 +331,7 @@ github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHH
 github.com/creack/pty v1.1.11 h1:07n33Z8lZxZ2qwegKbObQohDhXDQxiMMz1NOUGYlesw=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM=
 github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954 h1:RMLoZVzv4GliuWafOuPuQDKSm1SJph7uCRnnS61JAn4=
+github.com/dperny/gocsi v1.2.3-pre/go.mod h1:qQw5mIunz1RqMUfZcGJ9/Lt9EDaL0N3wPNYxFTuyLQo=
 github.com/emicklei/go-restful v2.9.5+incompatible h1:spTtZBk5DYEvbxMVutUuTyh1Ao2r4iyvLdACqsl/Ljk=
 github.com/emicklei/go-restful v2.9.5+incompatible/go.mod h1:otzb+WCGbkyDHkqmQmT5YD2WR4BBwUdeQoFo8l/7tVs=
 github.com/emicklei/go-restful/v3 v3.10.1 h1:rc42Y5YTp7Am7CS630D7JmhRjq4UlEUuEKfrDac4bSQ=