Add support for Subscription.config.affinity (#2826)

* vendor new o_f/api version

Signed-off-by: perdasilva <[email protected]>

* Update olm controller to handle Subscription.config.affinity

Signed-off-by: perdasilva <[email protected]>

Author: perdasilva

deploy/chart/crds/0000_50_olm_00-subscriptions.crd.yaml

@@ -24,7 +24,7 @@ require (
 	github.com/onsi/gomega v1.18.1
 	github.com/openshift/api v0.0.0-20200331152225-585af27e34fd
 	github.com/openshift/client-go v0.0.0-20200326155132-2a6cd50aedd0
-	github.com/operator-framework/api v0.15.0
+	github.com/operator-framework/api v0.15.1-0.20220801135701-ae4da2a9ec6a
 	github.com/operator-framework/operator-registry v1.17.5
 	github.com/otiai10/copy v1.2.0
 	github.com/pkg/errors v0.9.1

go.mod

@@ -1078,8 +1078,8 @@ github.com/openshift/client-go v0.0.0-20200326155132-2a6cd50aedd0/go.mod h1:uUQ4
 github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
 github.com/openzipkin/zipkin-go v0.1.6/go.mod h1:QgAqvLzwWbR/WpD4A3cGpPtJrZXNIiJc5AZX7/PBEpw=
 github.com/operator-framework/api v0.7.1/go.mod h1:L7IvLd/ckxJEJg/t4oTTlnHKAJIP/p51AvEslW3wYdY=
-github.com/operator-framework/api v0.15.0 h1:4f9i0drtqHj7ykLoHxv92GR43S7MmQHhmFQkfm5YaGI=
-github.com/operator-framework/api v0.15.0/go.mod h1:scnY9xqSeCsOdtJtNoHIXd7OtHZ14gj1hkDA4+DlgLY=
+github.com/operator-framework/api v0.15.1-0.20220801135701-ae4da2a9ec6a h1:KrRy9j95k4jHSXkyYUooQdAFju9eeER0izslDBUvcmA=
+github.com/operator-framework/api v0.15.1-0.20220801135701-ae4da2a9ec6a/go.mod h1:kk8xJahHJR3bKqrA+A+1VIrhOTmyV76k+ARv+iV+u1Q=
 github.com/operator-framework/operator-registry v1.17.5 h1:LR8m1rFz5Gcyje8WK6iYt+gIhtzqo52zMRALdmTYHT0=
 github.com/operator-framework/operator-registry v1.17.5/go.mod h1:sRQIgDMZZdUcmHltzyCnM6RUoDF+WS8Arj1BQIARDS8=
 github.com/otiai10/copy v1.2.0 h1:HvG945u96iNadPoG2/Ja2+AUJeW5YuFQMixq9yirC+k=

go.sum

@@ -16,7 +16,7 @@ type operatorConfig struct {
 	logger *logrus.Logger
 }
 
-func (o *operatorConfig) GetConfigOverrides(ownerCSV ownerutil.Owner) (envVarOverrides []corev1.EnvVar, volumeOverrides []corev1.Volume, volumeMountOverrides []corev1.VolumeMount, tolerationOverrides []corev1.Toleration, resourcesOverride *corev1.ResourceRequirements, nodeSelectorOverride map[string]string, err error) {
+func (o *operatorConfig) GetConfigOverrides(ownerCSV ownerutil.Owner) (envVarOverrides []corev1.EnvVar, volumeOverrides []corev1.Volume, volumeMountOverrides []corev1.VolumeMount, tolerationOverrides []corev1.Toleration, resourcesOverride *corev1.ResourceRequirements, nodeSelectorOverride map[string]string, affinity *corev1.Affinity, err error) {
 	list, listErr := o.lister.OperatorsV1alpha1().SubscriptionLister().Subscriptions(ownerCSV.GetNamespace()).List(labels.Everything())
 	if listErr != nil {
 		err = fmt.Errorf("failed to list subscription namespace=%s - %v", ownerCSV.GetNamespace(), listErr)
@@ -40,6 +40,7 @@ func (o *operatorConfig) GetConfigOverrides(ownerCSV ownerutil.Owner) (envVarOve
 	tolerationOverrides = owner.Spec.Config.Tolerations
 	resourcesOverride = owner.Spec.Config.Resources
 	nodeSelectorOverride = owner.Spec.Config.NodeSelector
+	affinity = owner.Spec.Config.Affinity
 
 	return
 }

pkg/controller/operators/olm/overrides/config.go

@@ -45,7 +45,7 @@ func (d *DeploymentInitializer) initialize(ownerCSV ownerutil.Owner, deployment
 	var envVarOverrides, proxyEnvVar, merged []corev1.EnvVar
 	var err error
 
-	envVarOverrides, volumeOverrides, volumeMountOverrides, tolerationOverrides, resourcesOverride, nodeSelectorOverride, err := d.config.GetConfigOverrides(ownerCSV)
+	envVarOverrides, volumeOverrides, volumeMountOverrides, tolerationOverrides, resourcesOverride, nodeSelectorOverride, affinity, err := d.config.GetConfigOverrides(ownerCSV)
 	if err != nil {
 		err = fmt.Errorf("failed to get subscription pod configuration - %v", err)
 		return err
@@ -92,6 +92,10 @@ func (d *DeploymentInitializer) initialize(ownerCSV ownerutil.Owner, deployment
 		return fmt.Errorf("failed to inject nodeSelector into deployment spec name=%s - %v", deployment.Name, err)
 	}
 
+	if err = inject.OverrideDeploymentAffinity(podSpec, affinity); err != nil {
+		return fmt.Errorf("failed to inject affinity into deployment spec name=%s - %s", deployment.Name, err)
+	}
+
 	return nil
 }
 

pkg/controller/operators/olm/overrides/initializer.go

@@ -230,3 +230,71 @@ func InjectNodeSelectorIntoDeployment(podSpec *corev1.PodSpec, nodeSelector map[
 
 	return nil
 }
+
+// OverrideDeploymentAffinity will override the corev1.Affinity defined in the Deployment
+// with the given corev1.Affinity. Any nil top-level sub-attributes (e.g. NodeAffinity, PodAffinity, and PodAntiAffinity)
+// will be ignored. Hint: to overwrite those top-level attributes, empty them out. I.e. use the empty/default object ({})
+// e.g. NodeAffinity{}. In yaml:
+// affinity:
+//   nodeAffinity: {}
+//   podAffinity: {}
+//   podAntiAffinity: {}
+// will completely remove the deployment podSpec.affinity and is equivalent to
+// affinity: {}
+func OverrideDeploymentAffinity(podSpec *corev1.PodSpec, affinity *corev1.Affinity) error {
+	if podSpec == nil {
+		return errors.New("no pod spec provided")
+	}
+
+	if affinity == nil {
+		return nil
+	}
+
+	// if podSpec.Affinity is nil or empty/default then completely override podSpec.Affinity with overrides
+	if podSpec.Affinity == nil || reflect.DeepEqual(podSpec.Affinity, &corev1.Affinity{}) {
+		if reflect.DeepEqual(affinity, &corev1.Affinity{}) {
+			podSpec.Affinity = nil
+		} else {
+			podSpec.Affinity = affinity
+		}
+		return nil
+	}
+
+	// if overriding affinity is empty/default then nil out podSpec.Affinity
+	if reflect.DeepEqual(affinity, &corev1.Affinity{}) {
+		podSpec.Affinity = nil
+		return nil
+	}
+
+	// override podSpec.Affinity each attribute as necessary nilling out any default/empty overrides on the podSpec
+	if affinity.NodeAffinity != nil {
+		if reflect.DeepEqual(affinity.NodeAffinity, &corev1.NodeAffinity{}) {
+			podSpec.Affinity.NodeAffinity = nil
+		} else {
+			podSpec.Affinity.NodeAffinity = affinity.NodeAffinity
+		}
+	}
+
+	if affinity.PodAffinity != nil {
+		if reflect.DeepEqual(affinity.PodAffinity, &corev1.PodAffinity{}) {
+			podSpec.Affinity.PodAffinity = nil
+		} else {
+			podSpec.Affinity.PodAffinity = affinity.PodAffinity
+		}
+	}
+
+	if affinity.PodAntiAffinity != nil {
+		if reflect.DeepEqual(affinity.PodAntiAffinity, &corev1.PodAntiAffinity{}) {
+			podSpec.Affinity = nil
+		} else {
+			podSpec.Affinity.PodAntiAffinity = affinity.PodAntiAffinity
+		}
+	}
+
+	// special case: if after being overridden, podSpec is the same as default/empty then nil it out
+	if reflect.DeepEqual(&corev1.Affinity{}, podSpec.Affinity) {
+		podSpec.Affinity = nil
+	}
+
+	return nil
+}