CNS IPAM for CNI (#584)

* Add IPAM to CNS for CNI

Author: matmerr

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,5 +1,6 @@
 ---
 name: 'Feature Request'
+
 about: Suggest an idea for this project.
 
 ---

Makefile

@@ -378,7 +378,13 @@ test-all:
         ./cnm/network/ \
         ./cni/ipam/ \
         ./cns/ipamclient/ \
+        ./cns/cnsclient/ \
         ./cns/requestcontroller/kubecontroller/ \
         ./cnms/service/ \
         ./npm/iptm/ \
         ./npm/ipsm/
+	
+	#until the restserver tests are fixed...
+	go test -timeout 30s \
+		./cns/restserver -run ^TestIPAM*
+		

cni/network/network.go

@@ -549,11 +549,11 @@ func (plugin *netPlugin) Add(args *cniSkel.CmdArgs) error {
 					Gateway: gateway,
 				},
 			},
-			BridgeName:       nwCfg.Bridge,
-			EnableSnatOnHost: nwCfg.EnableSnatOnHost,
-			DNS:              nwDNSInfo,
-			Policies:         policies,
-			NetNs:            args.Netns,
+			BridgeName:                    nwCfg.Bridge,
+			EnableSnatOnHost:              nwCfg.EnableSnatOnHost,
+			DNS:                           nwDNSInfo,
+			Policies:                      policies,
+			NetNs:                         args.Netns,
 			DisableHairpinOnHostInterface: nwCfg.DisableHairpinOnHostInterface,
 			IPV6Mode:                      nwCfg.IPV6Mode,
 			ServiceCidrs:                  nwCfg.ServiceCidrs,

cns/NetworkContainerContract.go

@@ -18,6 +18,8 @@ const (
 	GetNetworkContainerByOrchestratorContext = "/network/getnetworkcontainerbyorchestratorcontext"
 	AttachContainerToNetwork                 = "/network/attachcontainertonetwork"
 	DetachContainerFromNetwork               = "/network/detachcontainerfromnetwork"
+	RequestIPConfig                          = "/network/requestipconfig"
+	ReleaseIPConfig                          = "/network/releaseipconfig"
 )
 
 // NetworkContainer Prefixes
@@ -50,6 +52,13 @@ const (
 	Vxlan = "Vxlan"
 )
 
+// IPConfig States for CNS IPAM
+const (
+	Available      = "Available"
+	Allocated      = "Allocated"
+	PendingRelease = "PendingRelease"
+)
+
 // CreateNetworkContainerRequest specifies request to create a network container or network isolation boundary.
 type CreateNetworkContainerRequest struct {
 	Version                    string
@@ -87,6 +96,11 @@ type KubernetesPodInfo struct {
 	PodNamespace string
 }
 
+// GetOrchestratorContext will return the orchestratorcontext as a string
+func (podinfo *KubernetesPodInfo) GetOrchestratorContextKey() string {
+	return podinfo.PodName + ":" + podinfo.PodNamespace
+}
+
 // MultiTenancyInfo contains encap type and id.
 type MultiTenancyInfo struct {
 	EncapType string
@@ -100,6 +114,19 @@ type IPConfiguration struct {
 	GatewayIPAddress string
 }
 
+type SecondaryIPConfig struct {
+	UUID     string
+	IPConfig IPSubnet
+}
+
+type ContainerIPConfigState struct {
+	IPConfig            IPSubnet
+	ID                  string //uuid
+	NCID                string
+	State               string
+	OrchestratorContext json.RawMessage
+}
+
 // IPSubnet contains ip subnet.
 type IPSubnet struct {
 	IPAddress    string
@@ -158,6 +185,16 @@ type GetNetworkContainerResponse struct {
 	AllowNCToHostCommunication bool
 }
 
+type GetIPConfigRequest struct {
+	DesiredIPConfig     IPSubnet
+	OrchestratorContext json.RawMessage
+}
+
+type GetIPConfigResponse struct {
+	IPConfiguration IPConfiguration
+	Response        Response
+}
+
 // DeleteNetworkContainerRequest specifies the details about the request to delete a specifc network container.
 type DeleteNetworkContainerRequest struct {
 	NetworkContainerid string

cns/cnsclient/cnsclient.go

@@ -16,7 +16,8 @@ type CNSClient struct {
 }
 
 const (
-	defaultCnsURL = "http://localhost:10090"
+	defaultCnsURL   = "http://localhost:10090"
+	contentTypeJSON = "application/json"
 )
 
 var (
@@ -67,7 +68,7 @@ func (cnsClient *CNSClient) GetNetworkConfiguration(orchestratorContext []byte)
 		return nil, err
 	}
 
-	res, err := httpc.Post(url, "application/json", &body)
+	res, err := httpc.Post(url, contentTypeJSON, &body)
 	if err != nil {
 		log.Errorf("[Azure CNSClient] HTTP Post returned error %v", err.Error())
 		return nil, err
@@ -98,8 +99,7 @@ func (cnsClient *CNSClient) GetNetworkConfiguration(orchestratorContext []byte)
 }
 
 // CreateHostNCApipaEndpoint creates an endpoint in APIPA network for host container connectivity.
-func (cnsClient *CNSClient) CreateHostNCApipaEndpoint(
-	networkContainerID string) (string, error) {
+func (cnsClient *CNSClient) CreateHostNCApipaEndpoint(networkContainerID string) (string, error) {
 	var (
 		err  error
 		body bytes.Buffer
@@ -118,7 +118,7 @@ func (cnsClient *CNSClient) CreateHostNCApipaEndpoint(
 		return "", err
 	}
 
-	res, err := httpc.Post(url, "application/json", &body)
+	res, err := httpc.Post(url, contentTypeJSON, &body)
 	if err != nil {
 		log.Errorf("[Azure CNSClient] HTTP Post returned error %v", err.Error())
 		return "", err
@@ -167,7 +167,7 @@ func (cnsClient *CNSClient) DeleteHostNCApipaEndpoint(networkContainerID string)
 		return err
 	}
 
-	res, err := httpc.Post(url, "application/json", &body)
+	res, err := httpc.Post(url, contentTypeJSON, &body)
 	if err != nil {
 		log.Errorf("[Azure CNSClient] HTTP Post returned error %v", err.Error())
 		return err
@@ -198,3 +198,112 @@ func (cnsClient *CNSClient) DeleteHostNCApipaEndpoint(networkContainerID string)
 
 	return nil
 }
+
+// RequestIPAddress calls the requestIPAddress in CNS
+func (cnsClient *CNSClient) RequestIPAddress(orchestratorContext []byte) (*cns.GetIPConfigResponse, error) {
+	var (
+		err      error
+		res      *http.Response
+		response *cns.GetIPConfigResponse
+	)
+
+	defer func() {
+		if err != nil {
+			cnsClient.ReleaseIPAddress(orchestratorContext)
+		}
+	}()
+
+	var body bytes.Buffer
+
+	httpc := &http.Client{}
+	url := cnsClient.connectionURL + cns.RequestIPConfig
+
+	payload := &cns.GetNetworkContainerRequest{
+		OrchestratorContext: orchestratorContext,
+	}
+
+	err = json.NewEncoder(&body).Encode(payload)
+	if err != nil {
+		log.Errorf("encoding json failed with %v", err)
+		return response, err
+	}
+
+	res, err = httpc.Post(url, contentTypeJSON, &body)
+	if err != nil {
+		log.Errorf("[Azure CNSClient] HTTP Post returned error %v", err.Error())
+		return response, err
+	}
+
+	defer res.Body.Close()
+
+	if res.StatusCode != http.StatusOK {
+		errMsg := fmt.Sprintf("[Azure CNSClient] RequestIPAddress invalid http status code: %v", res.StatusCode)
+		log.Errorf(errMsg)
+		return response, fmt.Errorf(errMsg)
+	}
+
+	err = json.NewDecoder(res.Body).Decode(&response)
+	if err != nil {
+		log.Errorf("[Azure CNSClient] Error received while parsing RequestIPAddress response resp:%v err:%v", res.Body, err.Error())
+		return response, err
+	}
+
+	if response.Response.ReturnCode != 0 {
+		log.Errorf("[Azure CNSClient] RequestIPAddress received error response :%v", response.Response.Message)
+		return response, fmt.Errorf(response.Response.Message)
+	}
+
+	return response, err
+}
+
+// ReleaseIPAddress calls releaseIPAddress on CNS
+func (cnsClient *CNSClient) ReleaseIPAddress(orchestratorContext []byte) error {
+	var (
+		err  error
+		res  *http.Response
+		body bytes.Buffer
+	)
+
+	httpc := &http.Client{}
+	url := cnsClient.connectionURL + cns.ReleaseIPConfig
+	log.Printf("ReleaseIPAddress url %v", url)
+
+	payload := &cns.GetNetworkContainerRequest{
+		OrchestratorContext: orchestratorContext,
+	}
+
+	err = json.NewEncoder(&body).Encode(payload)
+	if err != nil {
+		log.Errorf("encoding json failed with %v", err)
+		return err
+	}
+
+	res, err = httpc.Post(url, contentTypeJSON, &body)
+	if err != nil {
+		log.Errorf("[Azure CNSClient] HTTP Post returned error %v", err.Error())
+		return err
+	}
+
+	defer res.Body.Close()
+
+	if res.StatusCode != http.StatusOK {
+		errMsg := fmt.Sprintf("[Azure CNSClient] ReleaseIPAddress invalid http status code: %v", res.StatusCode)
+		log.Errorf(errMsg)
+		return fmt.Errorf(errMsg)
+	}
+
+	var resp cns.Response
+
+	err = json.NewDecoder(res.Body).Decode(&resp)
+	if err != nil {
+		log.Errorf("[Azure CNSClient] Error received while parsing ReleaseIPAddress response resp:%v err:%v", res.Body, err.Error())
+		return err
+	}
+
+	if resp.ReturnCode != 0 {
+		log.Errorf("[Azure CNSClient] ReleaseIPAddress received error response :%v", resp.Message)
+		return fmt.Errorf(resp.Message)
+	}
+
+	return err
+}