Merge pull request #489 from e0ne/cdi

CDI implementation

Author: SchSeba

Makefile

@@ -160,6 +160,7 @@ mockery: | $(BASE) $(GOMOCKERY) ; $(info  Running mockery...) @ ## Run golint on
 #	$Q cd $(BASE)/pkg/types && rm -rf mocks && $(GOMOCKERY) --all 2>/dev/null
 	$Q $(GOMOCKERY) --name=".*" --dir=pkg/types --output=pkg/types/mocks --recursive=false --log-level=debug
 	$Q $(GOMOCKERY) --name=".*" --dir=pkg/utils --output=pkg/utils/mocks --recursive=false --log-level=debug
+	$Q $(GOMOCKERY) --name=".*" --dir=pkg/cdi --output=pkg/cdi/mocks --recursive=false --log-level=debug
 
 .PHONY: help
 help: ; @ ## Display this help message

README.md

@@ -32,6 +32,7 @@
   - [CNI plugins in virtual environments](#cni-plugins-in-virtual-environments)
     - [Virtual environments with no iommu](#virtual-environments-with-no-iommu)
   - [Multi Architecture Support](#multi-architecture-support)
+  - [Container Device Interface](#container-device-interface)
   - [Issues and Contributing](#issues-and-contributing)
 
 ## SR-IOV Network Device Plugin
@@ -712,12 +713,15 @@ Buiding image for AMD64:
 $ DOCKERFILE=Dockerfile make image
 ```
 
-Buiding image for PPC64LE:
+Building image for PPC64LE:
 
 ```sh
 $ DOCKERFILE=images/Dockerfile.ppc64le TAG=ghcr.io/k8snetworkplumbingwg/sriov-device-plugin:latest-ppc64le make image
 ```
 
+## Container Device Interface
+To enable Container Device Interface (CDI) deployment please the see [CDI](deployments/cdi/README.md).
+
 ## Issues and Contributing
 
 We welcome your feedback and contributions to this project. Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.

cmd/sriovdp/main.go

@@ -27,12 +27,14 @@ const (
 	defaultConfig = "/etc/pcidp/config.json"
 )
 
-// Parse Command line flags
+// flagInit parse command line flags
 func flagInit(cp *cliParams) {
 	flag.StringVar(&cp.configFile, "config-file", defaultConfig,
 		"JSON device pool config file location")
 	flag.StringVar(&cp.resourcePrefix, "resource-prefix", "intel.com",
 		"resource name prefix used for K8s extended resource")
+	flag.BoolVar(&cp.useCdi, "use-cdi", false,
+		"Use Container Device Interface to expose devices in containers")
 }
 
 func main() {
@@ -86,4 +88,7 @@ func main() {
 	if err := rm.stopAllServers(); err != nil {
 		glog.Errorf("stopping servers produced error: %s", err.Error())
 	}
+	if err := rm.cleanupCDISpecs(); err != nil {
+		glog.Errorf("cleaning up CDI Specs produced error: %s", err.Error())
+	}
 }

cmd/sriovdp/manager.go

@@ -22,6 +22,7 @@ import (
 	"github.com/golang/glog"
 	"github.com/jaypipes/ghw"
 
+	cdiPkg "github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/cdi"
 	"github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/factory"
 	"github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/types"
 	"github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/utils"
@@ -31,20 +32,25 @@ const (
 	socketSuffix = "sock"
 )
 
+// cliParams presents CLI parameters for SR-IOV Network Device Plugin
 type cliParams struct {
 	configFile     string
 	resourcePrefix string
+	useCdi         bool
 }
 
+// resourceManager manages resources for SR-IOV Network Device Plugin binaries
 type resourceManager struct {
 	cliParams
 	pluginWatchMode bool
 	rFactory        types.ResourceFactory
 	configList      []*types.ResourceConfig
 	resourceServers []types.ResourceServer
 	deviceProviders map[types.DeviceType]types.DeviceProvider
+	cdi             cdiPkg.CDI
 }
 
+// newResourceManager initiates a new instance of resourceManager
 func newResourceManager(cp *cliParams) *resourceManager {
 	pluginWatchMode := utils.DetectPluginWatchMode(types.SockDir)
 	if pluginWatchMode {
@@ -53,7 +59,7 @@ func newResourceManager(cp *cliParams) *resourceManager {
 		glog.Infof("Using Deprecated Device Plugin Registry Path")
 	}
 
-	rf := factory.NewResourceFactory(cp.resourcePrefix, socketSuffix, pluginWatchMode)
+	rf := factory.NewResourceFactory(cp.resourcePrefix, socketSuffix, pluginWatchMode, cp.useCdi)
 	dp := make(map[types.DeviceType]types.DeviceProvider)
 	for k := range types.SupportedDevices {
 		dp[k] = rf.GetDeviceProvider(k)
@@ -64,6 +70,7 @@ func newResourceManager(cp *cliParams) *resourceManager {
 		pluginWatchMode: pluginWatchMode,
 		rFactory:        rf,
 		deviceProviders: dp,
+		cdi:             cdiPkg.New(),
 	}
 }
 
@@ -101,12 +108,16 @@ func (rm *resourceManager) readConfig() error {
 }
 
 func (rm *resourceManager) initServers() error {
+	err := rm.cleanupCDISpecs()
+	if err != nil {
+		glog.Errorf("Unable to delete CDI specs: %v", err)
+		return err
+	}
 	rf := rm.rFactory
 	glog.Infof("number of config: %d\n", len(rm.configList))
 	deviceAllocated := make(map[string]bool)
 	for _, rc := range rm.configList {
 		// Create new ResourcePool
-		glog.Infof("")
 		glog.Infof("Creating new ResourcePool: %s", rc.ResourceName)
 		glog.Infof("DeviceType: %+v", rc.DeviceType)
 		dp, ok := rm.deviceProviders[rc.DeviceType]
@@ -249,3 +260,12 @@ func (rm *resourceManager) discoverHostDevices() error {
 	}
 	return nil
 }
+
+func (rm *resourceManager) cleanupCDISpecs() error {
+	if rm.cliParams.useCdi {
+		if err := rm.cdi.CleanupSpecs(); err != nil {
+			return fmt.Errorf("unable to delete CDI specs: %v", err)
+		}
+	}
+	return nil
+}

cmd/sriovdp/manager_test.go

@@ -19,6 +19,8 @@ import (
 	"os"
 	"testing"
 
+	CDImocks "github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/cdi/mocks"
+
 	"github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/factory"
 	"github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/netdevice"
 	"github.com/k8snetworkplumbingwg/sriov-network-device-plugin/pkg/types"
@@ -441,7 +443,7 @@ var _ = Describe("Resource manager", func() {
 				_ = os.Unsetenv("GHW_CHROOT")
 			}()
 
-			rf := factory.NewResourceFactory("fake", "fake", true)
+			rf := factory.NewResourceFactory("fake", "fake", true, false)
 
 			rm := &resourceManager{
 				rFactory: rf,
@@ -615,5 +617,24 @@ var _ = Describe("Resource manager", func() {
 				Expect(err).To(HaveOccurred())
 			})
 		})
+		Context("when resource servers cleans CDI specs ", func() {
+			rs := &mocks.ResourceServer{}
+			rs.On("Stop").Return(nil)
+
+			cp = &cliParams{
+				configFile:     "/tmp/sriovdp/test_config",
+				resourcePrefix: "test_",
+				useCdi:         true,
+			}
+			rm = newResourceManager(cp)
+			cdi := &CDImocks.CDI{}
+			cdi.On("CleanupSpecs").Return(nil)
+			rm.cdi = &CDImocks.CDI{}
+
+			err := rm.stopAllServers()
+			It("shouldn't fail", func() {
+				Expect(err).NotTo(HaveOccurred())
+			})
+		})
 	})
 })

deployments/cdi/README.md

@@ -0,0 +1,11 @@
+# SR-IOV Network Device Plugin in CDI mode deployment
+
+SR-IOV Network Device Plugin supports [Container Device Interface (CDI)](https://github.com/container-orchestrated-devices/container-device-interface).
+
+To enable CDI mode, SR-IOV Network Device Plugin should be started with `--use-cdi` CLI argument.
+This mode has different deployment requirements: `sriovdp-daemonset.yaml`
+
+```yaml
+    - mountPath: /var/run/cdi
+      name: dynamic-cdi
+```