From 52d3d4abd1ee69fd3994daa35e2a175a73e4188d Mon Sep 17 00:00:00 2001
From: Mikko Ylinen <mikko.ylinen@intel.com>
Date: Tue, 23 May 2023 08:20:23 +0300
Subject: [PATCH] operator: fix setting QAT provisioning config volumeMount

setInitContainer() adds "init-sriov-numvfs" to initContainers
but uses initcontainerName constant to search where to add
the QAT configMap volumeMount. Fix by moving all code to use
the const.

It was also noticed in the controller logs that setting Pod
Volumes is not idempotent but broken DaemonSet gets created:

""intel-device-plugins-manager: Reconciler error "err="DaemonSet.apps
\"intel-qat-plugin\" is invalid: spec.template.spec.volumes[6].name:
Duplicate value: \"qat-config\"" controller="qatdeviceplugin"
controllerGroup="deviceplugin.intel.com"

Finally, change 'qat-config' to 'intel-qat-config-volume' to
better describe that it's a volume.

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
---
 pkg/controllers/qat/controller.go             | 33 +++++++++++++------
 .../qatdeviceplugin_controller_test.go        |  2 +-
 2 files changed, 24 insertions(+), 11 deletions(-)

diff --git a/pkg/controllers/qat/controller.go b/pkg/controllers/qat/controller.go
index 20bd3e9c..422c088f 100644
--- a/pkg/controllers/qat/controller.go
+++ b/pkg/controllers/qat/controller.go
@@ -37,6 +37,7 @@ import (
 const (
 	ownerKey          = ".metadata.controller.qat"
 	initcontainerName = "intel-qat-initcontainer"
+	qatConfigVolume   = "intel-qat-config-volume"
 )
 
 var defaultNodeSelector = deployments.QATPluginDaemonSet().Spec.Template.Spec.NodeSelector
@@ -96,10 +97,7 @@ func (c *controller) NewDaemonSet(rawObj client.Object) *apps.DaemonSet {
 		daemonSet.Spec.Template.Spec.NodeSelector = devicePlugin.Spec.NodeSelector
 	}
 
-	if devicePlugin.Spec.InitImage == "" {
-		daemonSet.Spec.Template.Spec.InitContainers = nil
-		daemonSet.Spec.Template.Spec.Volumes = removeVolume(daemonSet.Spec.Template.Spec.Volumes, "sysfs")
-	} else {
+	if devicePlugin.Spec.InitImage != "" {
 		setInitContainer(&daemonSet.Spec.Template.Spec, devicePlugin.Spec)
 	}
 
@@ -129,7 +127,7 @@ func (c *controller) UpdateDaemonSet(rawObj client.Object, ds *apps.DaemonSet) (
 		if ds.Spec.Template.Spec.InitContainers != nil {
 			ds.Spec.Template.Spec.InitContainers = nil
 			ds.Spec.Template.Spec.Volumes = removeVolume(ds.Spec.Template.Spec.Volumes, "sysfs")
-			ds.Spec.Template.Spec.Volumes = removeVolume(ds.Spec.Template.Spec.Volumes, "qat-config")
+			ds.Spec.Template.Spec.Volumes = removeVolume(ds.Spec.Template.Spec.Volumes, qatConfigVolume)
 			updated = true
 		}
 	} else {
@@ -220,7 +218,7 @@ func setInitContainer(dsSpec *v1.PodSpec, dpSpec devicepluginv1.QatDevicePluginS
 		{
 			Image:           dpSpec.InitImage,
 			ImagePullPolicy: "IfNotPresent",
-			Name:            "init-sriov-numvfs",
+			Name:            initcontainerName,
 			Env: []v1.EnvVar{
 				{
 					Name:  "ENABLED_QAT_PF_PCIIDS",
@@ -254,20 +252,35 @@ func setInitContainer(dsSpec *v1.PodSpec, dpSpec devicepluginv1.QatDevicePluginS
 	mode := int32(0440)
 
 	if dpSpec.ProvisioningConfig != "" {
-		dsSpec.Volumes = append(dsSpec.Volumes, v1.Volume{
-			Name: "qat-config",
+		qatVol := v1.Volume{
+			Name: qatConfigVolume,
 			VolumeSource: v1.VolumeSource{
 				ConfigMap: &v1.ConfigMapVolumeSource{
 					LocalObjectReference: v1.LocalObjectReference{Name: dpSpec.ProvisioningConfig},
 					DefaultMode:          &mode,
 				},
 			},
-		})
+		}
+
+		volumeUpdated := false
+
+		// update ProvisioningConfig volume
+		for idx, vol := range dsSpec.Volumes {
+			if vol.Name == qatConfigVolume {
+				dsSpec.Volumes[idx] = qatVol
+				volumeUpdated = true
+			}
+		}
+
+		// or add if it's completely missing
+		if !volumeUpdated {
+			dsSpec.Volumes = append(dsSpec.Volumes, qatVol)
+		}
 
 		for i, initcontainer := range dsSpec.InitContainers {
 			if initcontainer.Name == initcontainerName {
 				dsSpec.InitContainers[i].VolumeMounts = append(dsSpec.InitContainers[i].VolumeMounts, v1.VolumeMount{
-					Name:      "qat-config",
+					Name:      qatConfigVolume,
 					MountPath: "/qat-init/conf",
 				})
 			}
diff --git a/test/envtest/qatdeviceplugin_controller_test.go b/test/envtest/qatdeviceplugin_controller_test.go
index 7e09a407..1d4b6ddd 100644
--- a/test/envtest/qatdeviceplugin_controller_test.go
+++ b/test/envtest/qatdeviceplugin_controller_test.go
@@ -136,7 +136,7 @@ var _ = Describe("QatDevicePlugin Controller", func() {
 			}
 			mode := int32(0440)
 			expectedVolume := v1.Volume{
-				Name: "qat-config",
+				Name: "intel-qat-config-volume",
 				VolumeSource: v1.VolumeSource{
 					ConfigMap: &v1.ConfigMapVolumeSource{
 						LocalObjectReference: v1.LocalObjectReference{Name: updatedProvisioningConfig},