Moved CNM specific logic to CNM package

Author: ofiliz

cnm/cnm.go

@@ -9,10 +9,10 @@ import (
 	"os/signal"
 	"syscall"
 
+	"github.com/Azure/azure-container-networking/cnm/ipam"
+	"github.com/Azure/azure-container-networking/cnm/network"
 	"github.com/Azure/azure-container-networking/common"
-	"github.com/Azure/azure-container-networking/ipam"
 	"github.com/Azure/azure-container-networking/log"
-	"github.com/Azure/azure-container-networking/network"
 	"github.com/Azure/azure-container-networking/store"
 )
 
@@ -83,11 +83,6 @@ func printVersion() {
 
 // Main is the entry point for CNM plugin.
 func main() {
-	var netPlugin network.NetPlugin
-	var ipamPlugin ipam.IpamPlugin
-	var config common.PluginConfig
-	var err error
-
 	// Initialize and parse command line arguments.
 	common.ParseArgs(&args, printVersion)
 
@@ -102,20 +97,21 @@ func main() {
 	}
 
 	// Initialize plugin common configuration.
+	var config common.PluginConfig
 	config.Name = name
 	config.Version = version
 
 	// Create network plugin.
-	netPlugin, err = network.NewPlugin(&config)
+	netPlugin, err := network.NewPlugin(&config)
 	if err != nil {
-		fmt.Printf("Failed to create network plugin %v\n", err)
+		fmt.Printf("Failed to create network plugin, err:%v.\n", err)
 		return
 	}
 
 	// Create IPAM plugin.
-	ipamPlugin, err = ipam.NewPlugin(&config)
+	ipamPlugin, err := ipam.NewPlugin(&config)
 	if err != nil {
-		fmt.Printf("Failed to create IPAM plugin %v\n", err)
+		fmt.Printf("Failed to create IPAM plugin, err:%v.\n", err)
 		return
 	}
 
@@ -148,15 +144,15 @@ func main() {
 	if netPlugin != nil {
 		err = netPlugin.Start(&config)
 		if err != nil {
-			fmt.Printf("Failed to start network plugin %v\n", err)
+			fmt.Printf("Failed to start network plugin, err:%v.\n", err)
 			return
 		}
 	}
 
 	if ipamPlugin != nil {
 		err = ipamPlugin.Start(&config)
 		if err != nil {
-			fmt.Printf("Failed to start IPAM plugin %v\n", err)
+			fmt.Printf("Failed to start IPAM plugin, err:%v.\n", err)
 			return
 		}
 	}

cnm/ipam/api.go

@@ -0,0 +1,85 @@
+// Copyright Microsoft Corp.
+// All rights reserved.
+
+package ipam
+
+const (
+	// Libnetwork IPAM plugin endpoint type
+	EndpointType = "IpamDriver"
+
+	// Libnetwork IPAM plugin remote API paths
+	getCapabilitiesPath  = "/IpamDriver.GetCapabilities"
+	getAddressSpacesPath = "/IpamDriver.GetDefaultAddressSpaces"
+	requestPoolPath      = "/IpamDriver.RequestPool"
+	releasePoolPath      = "/IpamDriver.ReleasePool"
+	requestAddressPath   = "/IpamDriver.RequestAddress"
+	releaseAddressPath   = "/IpamDriver.ReleaseAddress"
+)
+
+// Request sent by libnetwork when querying plugin capabilities.
+type getCapabilitiesRequest struct {
+}
+
+// Response sent by plugin when registering its capabilities with libnetwork.
+type getCapabilitiesResponse struct {
+	RequiresMACAddress    bool
+	RequiresRequestReplay bool
+}
+
+// Request sent by libnetwork when querying the default address space names.
+type getDefaultAddressSpacesRequest struct {
+}
+
+// Response sent by plugin when returning the default address space names.
+type getDefaultAddressSpacesResponse struct {
+	LocalDefaultAddressSpace  string
+	GlobalDefaultAddressSpace string
+}
+
+// Request sent by libnetwork when acquiring a reference to an address pool.
+type requestPoolRequest struct {
+	AddressSpace string
+	Pool         string
+	SubPool      string
+	Options      map[string]string
+	V6           bool
+}
+
+// Response sent by plugin when an address pool is successfully referenced.
+type requestPoolResponse struct {
+	PoolID string
+	Pool   string
+	Data   map[string]string
+}
+
+// Request sent by libnetwork when releasing a previously registered address pool.
+type releasePoolRequest struct {
+	PoolID string
+}
+
+// Response sent by plugin when an address pool is successfully released.
+type releasePoolResponse struct {
+}
+
+// Request sent by libnetwork when reserving an address from a pool.
+type requestAddressRequest struct {
+	PoolID  string
+	Address string
+	Options map[string]string
+}
+
+// Response sent by plugin when an address is successfully reserved.
+type requestAddressResponse struct {
+	Address string
+	Data    map[string]string
+}
+
+// Request sent by libnetwork when releasing an address back to the pool.
+type releaseAddressRequest struct {
+	PoolID  string
+	Address string
+}
+
+// Response sent by plugin when an address is successfully released.
+type releaseAddressResponse struct {
+}

ipam/plugin.go renamed to cnm/ipam/ipam.go

@@ -6,39 +6,41 @@ package ipam
 import (
 	"net/http"
 
+	"github.com/Azure/azure-container-networking/cnm/plugin"
 	"github.com/Azure/azure-container-networking/common"
+	"github.com/Azure/azure-container-networking/ipam"
 	"github.com/Azure/azure-container-networking/log"
 )
 
 const (
 	// Plugin name.
 	name = "ipam"
 
-	// Libnetwork IPAM plugin capabilities.
+	// Plugin capabilities reported to libnetwork.
 	requiresMACAddress    = false
 	requiresRequestReplay = false
 )
 
-// IpamPlugin object and interface
+// IpamPlugin represents a CNM (libnetwork) IPAM plugin.
 type ipamPlugin struct {
-	*common.Plugin
-	am AddressManager
+	*plugin.Plugin
+	am ipam.AddressManager
 }
 
 type IpamPlugin interface {
 	common.PluginApi
 }
 
-// Creates a new IpamPlugin object.
+// NewPlugin creates a new IpamPlugin object.
 func NewPlugin(config *common.PluginConfig) (IpamPlugin, error) {
 	// Setup base plugin.
-	plugin, err := common.NewPlugin(name, config.Version, endpointType)
+	plugin, err := plugin.NewPlugin(name, config.Version, EndpointType)
 	if err != nil {
 		return nil, err
 	}
 
 	// Setup address manager.
-	am, err := NewAddressManager()
+	am, err := ipam.NewAddressManager()
 	if err != nil {
 		return nil, err
 	}
@@ -51,7 +53,7 @@ func NewPlugin(config *common.PluginConfig) (IpamPlugin, error) {
 	}, nil
 }
 
-// Starts the plugin.
+// Start starts the plugin.
 func (plugin *ipamPlugin) Start(config *common.PluginConfig) error {
 	// Initialize base plugin.
 	err := plugin.Initialize(config)
@@ -82,7 +84,7 @@ func (plugin *ipamPlugin) Start(config *common.PluginConfig) error {
 	return nil
 }
 
-// Stops the plugin.
+// Stop stops the plugin.
 func (plugin *ipamPlugin) Stop() {
 	plugin.am.Uninitialize()
 	plugin.Uninitialize()
@@ -147,7 +149,7 @@ func (plugin *ipamPlugin) requestPool(w http.ResponseWriter, r *http.Request) {
 
 	// Encode response.
 	data := make(map[string]string)
-	poolId = NewAddressPoolId(req.AddressSpace, poolId, "").String()
+	poolId = ipam.NewAddressPoolId(req.AddressSpace, poolId, "").String()
 	resp := requestPoolResponse{PoolID: poolId, Pool: subnet, Data: data}
 
 	err = plugin.Listener.Encode(w, &resp)
@@ -167,7 +169,7 @@ func (plugin *ipamPlugin) releasePool(w http.ResponseWriter, r *http.Request) {
 	}
 
 	// Process request.
-	poolId, err := NewAddressPoolIdFromString(req.PoolID)
+	poolId, err := ipam.NewAddressPoolIdFromString(req.PoolID)
 	if err != nil {
 		plugin.SendErrorResponse(w, err)
 		return
@@ -199,7 +201,7 @@ func (plugin *ipamPlugin) requestAddress(w http.ResponseWriter, r *http.Request)
 	}
 
 	// Process request.
-	poolId, err := NewAddressPoolIdFromString(req.PoolID)
+	poolId, err := ipam.NewAddressPoolIdFromString(req.PoolID)
 	if err != nil {
 		plugin.SendErrorResponse(w, err)
 		return
@@ -232,7 +234,7 @@ func (plugin *ipamPlugin) releaseAddress(w http.ResponseWriter, r *http.Request)
 	}
 
 	// Process request.
-	poolId, err := NewAddressPoolIdFromString(req.PoolID)
+	poolId, err := ipam.NewAddressPoolIdFromString(req.PoolID)
 	if err != nil {
 		plugin.SendErrorResponse(w, err)
 		return

ipam/plugin_test.go renamed to cnm/ipam/ipam_test.go

@@ -52,7 +52,7 @@ func TestMain(m *testing.M) {
 	mux = plugin.(*ipamPlugin).Listener.GetMux()
 
 	// Get the internal config sink interface.
-	sink = plugin.(*ipamPlugin).am.(*addressManager)
+	sink = plugin.(*ipamPlugin).am
 
 	// Run tests.
 	exitCode := m.Run()