Add Azure-npm to provide k8s network policy support (#173)

* address comments

* make azure-npm versiona consistent with main version

* Npm telemetry (#12)

* azure-npm

* set logging file

* parameterize telemetry API

* avoid null ptr derefence

* add telemetry to npm

* address comments

* add descriptive comments

* add copyright info

* returns on err

Author: Yongli Chen

Makefile

@@ -39,6 +39,14 @@ CNSFILES = \
 	$(COREFILES) \
 	$(CNMFILES)
 
+NPMFILES = \
+	$(wildcard npm/*.go) \
+	$(wildcard npm/ipsm/*.go) \
+	$(wildcard npm/iptm/*.go) \
+	$(wildcard npm/util/*.go) \
+	$(wildcard npm/plugin/*.go) \
+	$(COREFILES)
+
 # Build defaults.
 GOOS ?= linux
 GOARCH ?= amd64
@@ -48,12 +56,14 @@ CNM_DIR = cnm/plugin
 CNI_NET_DIR = cni/network/plugin
 CNI_IPAM_DIR = cni/ipam/plugin
 CNS_DIR = cns/service
+NPM_DIR = npm/plugin
 OUTPUT_DIR = output
 BUILD_DIR = $(OUTPUT_DIR)/$(GOOS)_$(GOARCH)
 CNM_BUILD_DIR = $(BUILD_DIR)/cnm
 CNI_BUILD_DIR = $(BUILD_DIR)/cni
 CNI_MULTITENANCY_BUILD_DIR = $(BUILD_DIR)/cni-multitenancy
 CNS_BUILD_DIR = $(BUILD_DIR)/cns
+NPM_BUILD_DIR = $(BUILD_DIR)/npm
 
 # Containerized build parameters.
 BUILD_CONTAINER_IMAGE = acn-build
@@ -83,7 +93,11 @@ CNS_ARCHIVE_NAME = azure-cns-$(GOOS)-$(GOARCH)-$(VERSION).$(ARCHIVE_EXT)
 CNM_PLUGIN_IMAGE ?= microsoft/azure-vnet-plugin
 CNM_PLUGIN_ROOTFS = azure-vnet-plugin-rootfs
 
+# Azure network policy manager parameters.
+AZURE_NPM_IMAGE = containernetworking/azure-npm
+
 VERSION ?= $(shell git describe --tags --always --dirty)
+AZURE_NPM_VERSION = VERSION
 
 ENSURE_OUTPUT_DIR_EXISTS := $(shell mkdir -p $(OUTPUT_DIR))
 
@@ -92,8 +106,10 @@ azure-cnm-plugin: $(CNM_BUILD_DIR)/azure-vnet-plugin$(EXE_EXT) cnm-archive
 azure-vnet: $(CNI_BUILD_DIR)/azure-vnet$(EXE_EXT)
 azure-vnet-ipam: $(CNI_BUILD_DIR)/azure-vnet-ipam$(EXE_EXT)
 azure-cni-plugin: azure-vnet azure-vnet-ipam cni-archive
-azure-cns:	$(CNS_BUILD_DIR)/azure-cns$(EXE_EXT) cns-archive 
-all-binaries: azure-cnm-plugin azure-cni-plugin azure-cns
+azure-cns: $(CNS_BUILD_DIR)/azure-cns$(EXE_EXT) cns-archive
+azure-npm: $(NPM_BUILD_DIR)/azure-npm
+
+all-binaries: azure-cnm-plugin azure-cni-plugin azure-cns azure-npm
 
 # Clean all build artifacts.
 .PHONY: clean
@@ -116,6 +132,10 @@ $(CNI_BUILD_DIR)/azure-vnet-ipam$(EXE_EXT): $(CNIFILES)
 $(CNS_BUILD_DIR)/azure-cns$(EXE_EXT): $(CNSFILES)
 	go build -v -o $(CNS_BUILD_DIR)/azure-cns$(EXE_EXT) -ldflags "-X main.version=$(VERSION) -s -w" $(CNS_DIR)/*.go
 
+# Build the Azure NPM plugin.
+$(NPM_BUILD_DIR)/azure-npm: $(NPMFILES)
+	go build -v -o $(NPM_BUILD_DIR)/azure-npm -ldflags "-X main.version=$(VERSION) -s -w" $(NPM_DIR)/*.go
+
 # Build all binaries in a container.
 .PHONY: all-binaries-containerized
 all-binaries-containerized:
@@ -171,6 +191,21 @@ azure-vnet-plugin-image: azure-cnm-plugin
 publish-azure-vnet-plugin-image:
 	docker plugin push $(CNM_PLUGIN_IMAGE):$(VERSION)
 
+# Build the Azure NPM image.
+.PHONY: azure-npm-image
+azure-npm-image: azure-npm
+	# Build the plugin image.
+	docker build \
+	-f npm/Dockerfile \
+	-t $(AZURE_NPM_IMAGE):$(AZURE_NPM_VERSION) \
+	--build-arg NPM_BUILD_DIR=$(NPM_BUILD_DIR) \
+	.
+	
+# Publish the Azure NPM image to a Docker registry
+.PHONY: publish-azure-npm-image
+publish-azure-npm-image:
+	docker push $(AZURE_NPM_IMAGE):$(AZURE_NPM_VERSION)
+
 # Create a CNI archive for the target platform.
 .PHONY: cni-archive
 cni-archive:

cni/network/network.go

@@ -33,7 +33,7 @@ const (
 type netPlugin struct {
 	*cni.Plugin
 	nm            network.NetworkManager
-	reportManager *telemetry.ReportManager
+	reportManager *telemetry.CNIReportManager
 }
 
 // NewPlugin creates a new netPlugin object.
@@ -58,7 +58,7 @@ func NewPlugin(config *common.PluginConfig) (*netPlugin, error) {
 	}, nil
 }
 
-func (plugin *netPlugin) SetReportManager(reportManager *telemetry.ReportManager) {
+func (plugin *netPlugin) SetReportManager(reportManager *telemetry.CNIReportManager) {
 	plugin.reportManager = reportManager
 }
 

cni/network/plugin/main.go

@@ -24,7 +24,7 @@ const (
 var version string
 
 // If report write succeeded, mark the report flag state to false.
-func markSendReport(reportManager *telemetry.ReportManager) {
+func markSendReport(reportManager *telemetry.CNIReportManager) {
 	if err := reportManager.Report.SetReportState(); err != nil {
 		log.Printf("SetReportState failed due to %v", err)
 		reportManager.Report.ErrorMessage = err.Error()
@@ -36,7 +36,7 @@ func markSendReport(reportManager *telemetry.ReportManager) {
 }
 
 // send error report to hostnetagent if CNI encounters any error.
-func reportPluginError(reportManager *telemetry.ReportManager, err error) {
+func reportPluginError(reportManager *telemetry.CNIReportManager, err error) {
 	log.Printf("Report plugin error")
 	reportManager.GetReport(pluginName, version)
 	reportManager.Report.ErrorMessage = err.Error()
@@ -53,11 +53,13 @@ func main() {
 	var config common.PluginConfig
 	var err error
 	config.Version = version
-	reportManager := &telemetry.ReportManager{
-		HostNetAgentURL: hostNetAgentURL,
-		IpamQueryURL:    ipamQueryURL,
-		ReportType:      reportType,
-		Report:          &telemetry.Report{},
+	reportManager := &telemetry.CNIReportManager{
+		ReportMangager: &telemetry.ReportManager{
+			HostNetAgentURL: hostNetAgentURL,
+			ReportType:      reportType,
+		},
+		IpamQueryURL: ipamQueryURL,
+		Report:       &telemetry.CNIReport{},
 	}
 
 	reportManager.GetReport(pluginName, config.Version)

npm/Dockerfile

@@ -0,0 +1,15 @@
+# Use a minimal image as a parent image
+FROM ubuntu:16.04
+ARG NPM_BUILD_DIR
+
+# Install dependencies.
+RUN apt-get update
+RUN apt-get install -y iptables
+RUN apt-get install -y ipset
+
+# Install plugin.
+COPY $NPM_BUILD_DIR/azure-npm /usr/bin
+WORKDIR /usr/bin
+
+# Run the npm command by default when the container starts.
+ENTRYPOINT ["/usr/bin/azure-npm"]