hypershift: Add version annotation to controller Deployments

New annotation `release.openshift.io/version` signals that rollout of Deployment is complete (see https://issues.redhat.com/browse/STOR-2523 for details)

Author: mpatlasov

pkg/driver/aws-ebs/aws_ebs.go

@@ -187,6 +187,7 @@ func GetAWSEBSOperatorControllerConfig(ctx context.Context, flavour generator.Cl
 	} else {
 		// HyperShift only hooks
 		cfg.AddDeploymentHookBuilders(c, getCustomAWSCABundleBuilder("user-ca-bundle"))
+		cfg.AddDeploymentHookBuilders(c, operator.GetDeploymentVersionBuilder())
 	}
 	cfg.DeploymentWatchedSecretNames = append(cfg.DeploymentWatchedSecretNames, cloudCredSecretName, metricsCertSecretName)
 	cfg.StaleConditionsName = []string{

pkg/driver/common/operator/hooks.go

@@ -1,6 +1,7 @@
 package operator
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"strconv"
@@ -15,8 +16,10 @@ import (
 	"github.com/openshift/library-go/pkg/controller/factory"
 	"github.com/openshift/library-go/pkg/operator/csi/csidrivercontrollerservicecontroller"
 	dc "github.com/openshift/library-go/pkg/operator/deploymentcontroller"
+	"github.com/openshift/library-go/pkg/operator/status"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/klog/v2"
@@ -252,3 +255,46 @@ func withHyperShiftRunAsUser(c *clients.Clients) (dc.DeploymentHookFunc, []facto
 	}
 	return hook, nil
 }
+
+func hasFinishedProgressing(deployment *appsv1.Deployment) bool {
+	if deployment.Status.ObservedGeneration != deployment.Generation {
+		// The Deployment controller did not act on the Deployment spec change yet.
+		// Any condition in the status may be stale.
+		return false
+	}
+	// Deployment whose rollout is complete gets Progressing condition with Reason NewReplicaSetAvailable condition.
+	// https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#complete-deployment
+	for _, cond := range deployment.Status.Conditions {
+		if cond.Type == appsv1.DeploymentProgressing {
+			return cond.Status == corev1.ConditionTrue && cond.Reason == "NewReplicaSetAvailable"
+		}
+	}
+	return false
+}
+
+func GetDeploymentVersionBuilder() config.DeploymentHookBuilder {
+	return func(c *clients.Clients) (dc.DeploymentHookFunc, []factory.Informer) {
+		hook := func(_ *opv1.OperatorSpec, deployment *appsv1.Deployment) error {
+			var desiredVersion string
+			for k, v := range deployment.Annotations {
+				if k == "release.openshift.io/desired-version" {
+					desiredVersion = v
+				}
+			}
+			if desiredVersion != status.VersionForOperatorFromEnv() {
+				return nil
+			}
+
+			// deployment.Status is empty: {0 0 0 0 0 0 <nil> [] <nil>}
+			deployment2, err := c.ControlPlaneKubeClient.AppsV1().Deployments(deployment.Namespace).Get(context.TODO(), deployment.Name, metav1.GetOptions{})
+			if err != nil {
+				return fmt.Errorf("could not get Deployment %s in Namespace %s: %w", deployment.Name, deployment.Namespace, err)
+			}
+			if hasFinishedProgressing(deployment2) {
+				deployment.Annotations["release.openshift.io/version"] = desiredVersion
+			}
+			return nil
+		}
+		return hook, nil
+	}
+}