new controller for managing upgrade of operator

Dockerfile

@@ -9,6 +9,9 @@ COPY go.mod go.sum ./
 # and so that source changes don't invalidate our built layer
 COPY vendor/ vendor/
 
+# CRD shims for go-test
+COPY shim/ shim/
+
 # Copy the project source
 COPY main.go Makefile ./
 COPY hack/ hack/

api/v1alpha1/storageclient_types.go

@@ -46,12 +46,20 @@ type StorageClientSpec struct {
 	OnboardingTicket string `json:"onboardingTicket"`
 }
 
+// OperatorVersion holds current and desired version
+type OperatorVersion struct {
+	CurrentVersion string `json:"currentVersion,omitempty"`
+	DesiredVersion string `json:"desiredVersion,omitempty"`
+}
+
 // StorageClientStatus defines the observed state of StorageClient
 type StorageClientStatus struct {
 	Phase storageClientPhase `json:"phase,omitempty"`
 
 	// ConsumerID will hold the identity of this cluster inside the attached provider cluster
 	ConsumerID string `json:"id,omitempty"`
+
+	Operator OperatorVersion `json:"operator,omitempty"`
 }
 
 //+kubebuilder:object:root=true

bundle/manifests/ocs-client-operator.clusterserviceversion.yaml

@@ -225,6 +225,14 @@ spec:
           - get
           - list
           - watch
+        - apiGroups:
+          - operators.coreos.com
+          resources:
+          - subscriptions
+          verbs:
+          - get
+          - list
+          - patch
         - apiGroups:
           - security.openshift.io
           resources:
@@ -608,13 +616,11 @@ spec:
           - list
           - update
         - apiGroups:
-          - config.openshift.io
+          - ocs.openshift.io
           resources:
-          - clusterversions
+          - storageclients/status
           verbs:
-          - get
-          - list
-          - watch
+          - patch
         serviceAccountName: ocs-client-operator-status-reporter
       deployments:
       - label:
@@ -687,7 +693,8 @@ spec:
           selector:
             matchLabels:
               control-plane: controller-manager
-          strategy: {}
+          strategy:
+            type: Recreate
           template:
             metadata:
               annotations:
@@ -902,16 +909,6 @@ spec:
           verbs:
           - create
         serviceAccountName: ocs-client-operator-csi-rbd-provisioner-sa
-      - rules:
-        - apiGroups:
-          - operators.coreos.com
-          resources:
-          - clusterserviceversions
-          verbs:
-          - get
-          - list
-          - watch
-        serviceAccountName: ocs-client-operator-status-reporter
     strategy: deployment
   installModes:
   - supported: true

bundle/manifests/ocs.openshift.io_storageclients.yaml

@@ -60,6 +60,14 @@ spec:
                 description: ConsumerID will hold the identity of this cluster inside
                   the attached provider cluster
                 type: string
+              operator:
+                description: OperatorVersion holds current and desired version
+                properties:
+                  currentVersion:
+                    type: string
+                  desiredVersion:
+                    type: string
+                type: object
               phase:
                 type: string
             type: object

config/crd/bases/ocs.openshift.io_storageclients.yaml

@@ -62,6 +62,14 @@ spec:
                 description: ConsumerID will hold the identity of this cluster inside
                   the attached provider cluster
                 type: string
+              operator:
+                description: OperatorVersion holds current and desired version
+                properties:
+                  currentVersion:
+                    type: string
+                  desiredVersion:
+                    type: string
+                type: object
               phase:
                 type: string
             type: object

config/manager/manager.yaml

@@ -13,6 +13,8 @@ metadata:
   labels:
     control-plane: controller-manager
 spec:
+  strategy:
+    type: Recreate
   selector:
     matchLabels:
       control-plane: controller-manager

config/rbac/kustomization.yaml

@@ -21,8 +21,6 @@ resources:
 - status-reporter-sa.yaml
 - status-reporter-clusterrole.yaml
 - status-reporter-clusterrole_binding.yaml
-- status-reporter-role.yaml
-- status-reporter-role_binding.yaml
 # CSI RBAC
 - csi_cephfs_plugin_clusterrole.yaml
 - csi_cephfs_plugin_clusterrole_binding.yaml

config/rbac/role.yaml

@@ -197,6 +197,14 @@ rules:
   - get
   - list
   - watch
+- apiGroups:
+  - operators.coreos.com
+  resources:
+  - subscriptions
+  verbs:
+  - get
+  - list
+  - patch
 - apiGroups:
   - security.openshift.io
   resources:

config/rbac/status-reporter-clusterrole.yaml

@@ -19,10 +19,8 @@ rules:
       - list
       - update
   - apiGroups:
-      - config.openshift.io
+      - ocs.openshift.io
     resources:
-      - clusterversions
+      - storageclients/status
     verbs:
-      - get
-      - list
-      - watch
+      - patch

controllers/storageclient_controller.go

@@ -23,14 +23,13 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
-	"strings"
 	"time"
 
+	"github.com/blang/semver/v4"
 	"github.com/red-hat-storage/ocs-client-operator/api/v1alpha1"
 	"github.com/red-hat-storage/ocs-client-operator/pkg/utils"
 
 	configv1 "github.com/openshift/api/config/v1"
-	opv1a1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	providerClient "github.com/red-hat-storage/ocs-operator/v4/services/provider/client"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
@@ -61,8 +60,6 @@ const (
 	storageClientNameLabel      = "ocs.openshift.io/storageclient.name"
 	storageClientNamespaceLabel = "ocs.openshift.io/storageclient.namespace"
 	storageClientFinalizer      = "storageclient.ocs.openshift.io"
-
-	csvPrefix = "ocs-client-operator"
 )
 
 // StorageClientReconciler reconciles a StorageClient object
@@ -74,6 +71,11 @@ type StorageClientReconciler struct {
 	recorder *utils.EventReporter
 
 	OperatorNamespace string
+	OperatorVersion   string
+
+	// this can be part of reconciler as after a platform update
+	// operator will get restarted and fetches latest version
+	PlatformVersion string
 }
 
 // SetupWithManager sets up the controller with the Manager.
@@ -202,6 +204,10 @@ func (s *StorageClientReconciler) reconcilePhases(instance *v1alpha1.StorageClie
 		return s.acknowledgeOnboarding(instance, externalClusterClient)
 	}
 
+	if res, err := s.reconcileClientStatus(instance); err != nil {
+		return res, err
+	}
+
 	if res, err := s.reconcileClientStatusReporterJob(instance); err != nil {
 		return res, err
 	}
@@ -271,22 +277,11 @@ func (s *StorageClientReconciler) onboardConsumer(instance *v1alpha1.StorageClie
 		return reconcile.Result{}, fmt.Errorf("failed to get the clusterVersion version of the OCP cluster: %v", err)
 	}
 
-	// TODO Have a version file corresponding to the release
-	csvList := opv1a1.ClusterServiceVersionList{}
-	if err = s.list(&csvList, client.InNamespace(s.OperatorNamespace)); err != nil {
-		return reconcile.Result{}, fmt.Errorf("failed to list csv resources in ns: %v, err: %v", s.OperatorNamespace, err)
-	}
-	csv := utils.Find(csvList.Items, func(csv *opv1a1.ClusterServiceVersion) bool {
-		return strings.HasPrefix(csv.Name, csvPrefix)
-	})
-	if csv == nil {
-		return reconcile.Result{}, fmt.Errorf("unable to find csv with prefix %q", csvPrefix)
-	}
 	name := fmt.Sprintf("storageconsumer-%s", clusterVersion.Spec.ClusterID)
 	onboardRequest := providerClient.NewOnboardConsumerRequest().
 		SetConsumerName(name).
 		SetOnboardingTicket(instance.Spec.OnboardingTicket).
-		SetClientOperatorVersion(csv.Spec.Version.String())
+		SetClientOperatorVersion(s.OperatorVersion)
 	response, err := externalClusterClient.OnboardConsumer(s.ctx, onboardRequest)
 	if err != nil {
 		if st, ok := status.FromError(err); ok {
@@ -445,6 +440,26 @@ func (s *StorageClientReconciler) delete(obj client.Object) error {
 	return nil
 }
 
+func (s *StorageClientReconciler) reconcileClientStatus(instance *v1alpha1.StorageClient) (reconcile.Result, error) {
+	currentVersion := instance.Status.Operator.CurrentVersion
+	operatorVersion, _ := semver.Make(s.OperatorVersion)
+	if currentVersion == "" {
+		// TODO(lgangava): should we set Major.Minor.Patch or Major.Minor only
+		instance.Status.Operator.CurrentVersion = fmt.Sprintf("%d.%d", operatorVersion.Major, operatorVersion.Minor)
+		return reconcile.Result{}, nil
+	}
+
+	instanceVersion, _ := semver.Make(currentVersion)
+	// operator can be backward compatible to it's operand but it couldn't reconcile the object
+	// which was initially reconciled by higher versioned operator
+	if operatorVersion.Major < instanceVersion.Major || operatorVersion.Minor < instanceVersion.Minor {
+		return reconcile.Result{}, fmt.Errorf("backing off from reconciling StorageClient at higher version %q", currentVersion)
+	}
+
+	instance.Status.Operator.CurrentVersion = fmt.Sprintf("%d.%d", operatorVersion.Major, operatorVersion.Minor)
+	return reconcile.Result{}, nil
+}
+
 func (s *StorageClientReconciler) reconcileClientStatusReporterJob(instance *v1alpha1.StorageClient) (reconcile.Result, error) {
 	// start the cronJob to ping the provider api server
 	cronJob := &batchv1.CronJob{}
@@ -489,6 +504,10 @@ func (s *StorageClientReconciler) reconcileClientStatusReporterJob(instance *v1a
 											Name:  utils.OperatorNamespaceEnvVar,
 											Value: s.OperatorNamespace,
 										},
+										{
+											Name:  utils.PlatformVersionEnvVar,
+											Value: s.PlatformVersion,
+										},
 									},
 								},
 							},
@@ -506,7 +525,3 @@ func (s *StorageClientReconciler) reconcileClientStatusReporterJob(instance *v1a
 	}
 	return reconcile.Result{}, nil
 }
-
-func (s *StorageClientReconciler) list(obj client.ObjectList, listOptions ...client.ListOption) error {
-	return s.Client.List(s.ctx, obj, listOptions...)
-}