Merge pull request #1372 from hj-johannes-lee/qat-initcontainer-improvement

qat init: make qat.conf optional

Author: mythi

cmd/qat_plugin/README.md

@@ -44,7 +44,7 @@ The QAT plugin can take a number of command line arguments, summarised in the fo
 |:---- |:-------- |:------- |
 | -dpdk-driver | string | DPDK Device driver for configuring the QAT device (default: `vfio-pci`) |
 | -kernel-vf-drivers | string | Comma separated VF Device Driver of the QuickAssist Devices in the system. Devices supported: DH895xCC, C62x, C3xxx, 4xxx/401xx/402xx, C4xxx and D15xx (default: `c6xxvf,4xxxvf`) |
-| -max-num-devices | int | maximum number of QAT devices to be provided to the QuickAssist device plugin (default: `32`) |
+| -max-num-devices | int | maximum number of QAT devices to be provided to the QuickAssist device plugin (default: `64`) |
 | -mode | string | plugin mode which can be either `dpdk` or `kernel` (default: `dpdk`) |
 | -allocation-policy | string | 2 possible values: balanced and packed. Balanced mode spreads allocated QAT VF resources balanced among QAT PF devices, and packed mode packs one QAT PF device full of QAT VF resources before allocating resources from the next QAT PF. (There is no default.) |
 
@@ -136,12 +136,11 @@ In addition to the default configuration, you can add device-specific configurat
 |:-------|:-----------------------|:-----------------|:--------|:------|
 | 4xxx, 401xx,402xx | [cfg_services](https://github.com/torvalds/linux/blob/42e66b1cc3a070671001f8a1e933a80818a192bf/Documentation/ABI/testing/sysfs-driver-qat) reports the configured services (crypto services or compression services) of the QAT device. | `ServicesEnabled=<value>` | compress:`dc`, crypto:`sym;asym` | Linux 6.0+ kernel is required. |
 
-To create a provisioning config after customizing, run as follows:
+To create a provisioning `configMap`, run the following command before deploying initcontainer:
 
 ```bash
 $ kubectl create configmap --namespace=inteldeviceplugins-system qat-config --from-file=deployments/qat_plugin/overlays/qat_initcontainer/qat.conf
 ```
-> **Note**: When deploying the overlay qat_initcontainer, such a manual creation is not necessary since ConfigMap is generated automatically. Just set the values in the config file and deploy the overlay.
 
 When using the operator for deploying the plugin with provisioning config, use `provisioningConfig` field for the name of the ConfigMap, then the config is passed to initcontainer through the volume mount.
 

cmd/qat_plugin/qat_plugin.go

@@ -42,7 +42,7 @@ func main() {
 	dpdkDriver := flag.String("dpdk-driver", "vfio-pci", "DPDK Device driver for configuring the QAT device")
 	kernelVfDrivers := flag.String("kernel-vf-drivers", "c6xxvf,4xxxvf", "Comma separated VF Device Driver of the QuickAssist Devices in the system. Devices supported: DH895xCC, C62x, C3xxx, C4xxx, 4xxx, and D15xx")
 	preferredAllocationPolicy := flag.String("allocation-policy", "", "Modes of allocating QAT devices: balanced and packed")
-	maxNumDevices := flag.Int("max-num-devices", 32, "maximum number of QAT devices to be provided to the QuickAssist device plugin")
+	maxNumDevices := flag.Int("max-num-devices", 64, "maximum number of QAT devices to be provided to the QuickAssist device plugin")
 	flag.Parse()
 
 	switch *mode {

deployments/qat_plugin/overlays/qat_initcontainer/kustomization.yaml

@@ -2,7 +2,3 @@ bases:
 - ../../base
 patchesStrategicMerge:
 - qat_initcontainer.yaml
-configMapGenerator:
-- name: qat-config
-  files:
-  - qat.conf

deployments/qat_plugin/overlays/qat_initcontainer/qat.conf

@@ -28,4 +28,5 @@ spec:
       - name: qat-config
         configMap:
           name: qat-config
+          optional: true
           defaultMode: 0440

deployments/qat_plugin/overlays/qat_initcontainer/qat_initcontainer.yaml

@@ -20,6 +20,7 @@ import (
 
 	"github.com/intel/intel-device-plugins-for-kubernetes/test/e2e/utils"
 	"github.com/onsi/ginkgo/v2"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/kubernetes/test/e2e/framework"
 	e2edebug "k8s.io/kubernetes/test/e2e/framework/debug"
@@ -65,7 +66,9 @@ func describeQatDpdkPlugin() {
 
 	var dpPodName string
 
-	ginkgo.BeforeEach(func() {
+	var resourceName v1.ResourceName
+
+	ginkgo.JustBeforeEach(func() {
 		ginkgo.By("deploying QAT plugin in DPDK mode")
 		e2ekubectl.RunKubectlOrDie(f.Namespace.Name, "apply", "-k", filepath.Dir(kustomizationPath))
 
@@ -83,6 +86,11 @@ func describeQatDpdkPlugin() {
 		if err := utils.TestPodsFileSystemInfo(podList.Items); err != nil {
 			framework.Failf("container filesystem info checks failed: %v", err)
 		}
+
+		ginkgo.By("checking if the resource is allocatable")
+		if err := utils.WaitForNodesWithResource(f.ClientSet, resourceName, 30*time.Second); err != nil {
+			framework.Failf("unable to wait for nodes to have positive allocatable resource: %v", err)
+		}
 	})
 
 	ginkgo.AfterEach(func() {
@@ -93,12 +101,14 @@ func describeQatDpdkPlugin() {
 		}
 	})
 
-	ginkgo.Context("When QAT Gen4 resources are available", func() {
+	ginkgo.Context("When QAT Gen4 resources are available with crypto (cy) services enabled", func() {
+		// This BeforeEach runs even before the JustBeforeEach above.
 		ginkgo.BeforeEach(func() {
-			ginkgo.By("checking if the resource is allocatable")
-			if err := utils.WaitForNodesWithResource(f.ClientSet, "qat.intel.com/cy", 30*time.Second); err != nil {
-				framework.Failf("unable to wait for nodes to have positive allocatable resource: %v", err)
-			}
+			ginkgo.By("creating a configMap before plugin gets deployed")
+			e2ekubectl.RunKubectlOrDie(f.Namespace.Name, "create", "configmap", "--from-literal", "qat.conf=ServicesEnabled=sym;asym", "qat-config")
+
+			ginkgo.By("setting resourceName for cy services")
+			resourceName = "qat.intel.com/cy"
 		})
 
 		ginkgo.It("deploys a crypto pod requesting QAT resources", func() {
@@ -116,10 +126,8 @@ func describeQatDpdkPlugin() {
 
 	ginkgo.Context("When QAT Gen2 resources are available", func() {
 		ginkgo.BeforeEach(func() {
-			ginkgo.By("checking if the resource is allocatable")
-			if err := utils.WaitForNodesWithResource(f.ClientSet, "qat.intel.com/generic", 30*time.Second); err != nil {
-				framework.Failf("unable to wait for nodes to have positive allocatable resource: %v", err)
-			}
+			ginkgo.By("setting resourceName for Gen2 resources")
+			resourceName = "qat.intel.com/generic"
 		})
 
 		ginkgo.It("deploys a crypto pod requesting QAT resources", func() {