Allow publishing of additional information to IPAM

Adds an IPAM driver capability that allows libnetwork
to send additional information during subnet and address
allocation.

Signed-off-by: John Belamaric <[email protected]>

Author: johnbelamaric

ipamapi/contract.go

@@ -78,5 +78,7 @@ type Ipam interface {
 
 // Capability represents the requirements and capabilities of the IPAM driver
 type Capability struct {
-	RequiresMACAddress bool
+	RequiresMACAddress   bool
+	RequiresEndpointInfo bool
+	RequiresNetworkInfo  bool
 }

ipams/remote/api/api.go

@@ -22,12 +22,17 @@ func (r *Response) GetError() string {
 // GetCapabilityResponse is the response of GetCapability request
 type GetCapabilityResponse struct {
 	Response
-	RequiresMACAddress bool
+	RequiresMACAddress   bool
+	RequiresEndpointInfo bool
+	RequiresNetworkInfo  bool
 }
 
 // ToCapability converts the capability response into the internal ipam driver capaility structure
 func (capRes GetCapabilityResponse) ToCapability() *ipamapi.Capability {
-	return &ipamapi.Capability{RequiresMACAddress: capRes.RequiresMACAddress}
+	return &ipamapi.Capability{
+		RequiresMACAddress:   capRes.RequiresMACAddress,
+		RequiresEndpointInfo: capRes.RequiresEndpointInfo,
+		RequiresNetworkInfo:  capRes.RequiresNetworkInfo}
 }
 
 // GetAddressSpacesResponse is the response to the ``get default address spaces`` request message

netlabel/labels.go

@@ -24,6 +24,21 @@ const (
 	// MacAddress constant represents Mac Address config of a Container
 	MacAddress = Prefix + ".endpoint.macaddress"
 
+	// NetworkName constant represents the network name
+	NetworkName = Prefix + ".name"
+
+	// NetworkID constant represents the network ID
+	NetworkID = Prefix + ".id"
+
+	// NetworkType constant represents the network type/driver name
+	NetworkType = Prefix + ".type"
+
+	// EndpointName constant represents the endpoint/container name
+	EndpointName = Prefix + ".endpoint.name"
+
+	// EndpointHost constant represents the cluster host ID
+	EndpointHost = Prefix + ".endpoint.cluster_host_id"
+
 	// ExposedPorts constant represents the container's Exposed Ports
 	ExposedPorts = Prefix + ".endpoint.exposedports"
 

network.go

@@ -736,6 +736,15 @@ func (n *network) CreateEndpoint(name string, options ...EndpointOption) (Endpoi
 		ep.ipamOptions[netlabel.MacAddress] = ep.iface.mac.String()
 	}
 
+	if ipam.capability.RequiresEndpointInfo {
+		if ep.ipamOptions == nil {
+			ep.ipamOptions = make(map[string]string)
+		}
+		log.Debugf("Endpoint: %s", ep)
+		ep.ipamOptions[netlabel.EndpointName] = name
+		ep.ipamOptions[netlabel.EndpointHost] = ep.locator
+	}
+
 	if err = ep.assignAddress(ipam.driver, true, !n.postIPv6); err != nil {
 		return nil, err
 	}
@@ -1009,6 +1018,20 @@ func (n *network) ipamAllocateVersion(ipVer int, ipam ipamapi.Ipam) error {
 
 	*infoList = make([]*IpamInfo, len(*cfgList))
 
+	id, err := n.getController().getIPAM(n.ipamType)
+	if err != nil {
+		return err
+	}
+
+	if id.capability.RequiresNetworkInfo {
+		if n.ipamOptions == nil {
+			n.ipamOptions = make(map[string]string)
+		}
+		n.ipamOptions[netlabel.NetworkName] = n.Name()
+		n.ipamOptions[netlabel.NetworkID] = n.ID()
+		n.ipamOptions[netlabel.NetworkType] = n.Type()
+	}
+
 	log.Debugf("Allocating IPv%d pools for network %s (%s)", ipVer, n.Name(), n.ID())
 
 	for i, cfg := range *cfgList {