feat: move versions in database object annotations

formancehq · Feb 8, 2024 · 2351295 · 2351295
1 parent 0cc3fca
commit 2351295
Show file tree

Hide file tree

Showing 20 changed files with 47 additions and 38 deletions.
diff --git a/components/operator/api/formance.com/v1beta1/ledger_types.go b/components/operator/api/formance.com/v1beta1/ledger_types.go
@@ -66,8 +66,6 @@ type LedgerSpec struct {
 // LedgerStatus defines the observed state of Ledger
 type LedgerStatus struct {
 	ModuleStatus `json:",inline"`
-	//+optional
-	Version string `json:"version,omitempty"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/components/operator/api/formance.com/v1beta1/payments_types.go b/components/operator/api/formance.com/v1beta1/payments_types.go
@@ -33,8 +33,6 @@ type PaymentsSpec struct {
 // PaymentsStatus defines the observed state of Payments
 type PaymentsStatus struct {
 	ModuleStatus `json:",inline"`
-	//+optional
-	Version string `json:"version,omitempty"`
 }
 
 //+kubebuilder:object:root=true

diff --git a/components/operator/api/formance.com/v1beta1/shared.go b/components/operator/api/formance.com/v1beta1/shared.go
@@ -133,8 +133,6 @@ func (c *StatusWithConditions) SetCondition(condition Condition) {
 
 type ModuleStatus struct {
 	StatusWithConditions `json:",inline"`
-	//+optional
-	Version string `json:"version,omitempty"`
 }
 
 type AuthConfig struct {

diff --git a/components/operator/config/crd/bases/formance.com_auths.yaml b/components/operator/config/crd/bases/formance.com_auths.yaml
@@ -168,8 +168,6 @@ spec:
                 type: string
               ready:
                 type: boolean
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/config/crd/bases/formance.com_gateways.yaml b/components/operator/config/crd/bases/formance.com_gateways.yaml
@@ -166,8 +166,6 @@ spec:
                 items:
                   type: string
                 type: array
-              version:
-                type: string
             required:
             - authEnabled
             type: object

diff --git a/components/operator/config/crd/bases/formance.com_ledgers.yaml b/components/operator/config/crd/bases/formance.com_ledgers.yaml
@@ -168,8 +168,6 @@ spec:
                 type: string
               ready:
                 type: boolean
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/config/crd/bases/formance.com_orchestrations.yaml b/components/operator/config/crd/bases/formance.com_orchestrations.yaml
@@ -138,8 +138,6 @@ spec:
                 type: boolean
               temporalURI:
                 type: string
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/config/crd/bases/formance.com_payments.yaml b/components/operator/config/crd/bases/formance.com_payments.yaml
@@ -138,8 +138,6 @@ spec:
                 type: string
               ready:
                 type: boolean
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/config/crd/bases/formance.com_reconciliations.yaml b/components/operator/config/crd/bases/formance.com_reconciliations.yaml
@@ -136,8 +136,6 @@ spec:
                 type: string
               ready:
                 type: boolean
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/config/crd/bases/formance.com_searches.yaml b/components/operator/config/crd/bases/formance.com_searches.yaml
@@ -148,8 +148,6 @@ spec:
                 type: string
               ready:
                 type: boolean
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/config/crd/bases/formance.com_stargates.yaml b/components/operator/config/crd/bases/formance.com_stargates.yaml
@@ -153,8 +153,6 @@ spec:
                 type: string
               ready:
                 type: boolean
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/config/crd/bases/formance.com_wallets.yaml b/components/operator/config/crd/bases/formance.com_wallets.yaml
@@ -136,8 +136,6 @@ spec:
                 type: string
               ready:
                 type: boolean
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/config/crd/bases/formance.com_webhooks.yaml b/components/operator/config/crd/bases/formance.com_webhooks.yaml
@@ -136,8 +136,6 @@ spec:
                 type: string
               ready:
                 type: boolean
-              version:
-                type: string
             type: object
         type: object
     served: true

diff --git a/components/operator/internal/resources/auths/controller.go b/components/operator/internal/resources/auths/controller.go
@@ -59,11 +59,14 @@ func Reconcile(ctx Context, stack *v1beta1.Stack, auth *v1beta1.Auth, version st
 			return errors.Wrap(err, "resolving image")
 		}
 
-		if IsGreaterOrEqual(version, "v2.0.0-rc.5") && auth.Status.Version != version {
+		if IsGreaterOrEqual(version, "v2.0.0-rc.5") && databases.GetSavedModuleVersion(database) != version {
 			if err := jobs.Handle(ctx, auth, "migrate", databases.MigrateDatabaseContainer(image, database)); err != nil {
 				return err
 			}
-			auth.Status.Version = version
+
+			if err := databases.SaveModuleVersion(ctx, database, version); err != nil {
+				return errors.Wrap(err, "saving module version in database object")
+			}
 		}
 
 		_, err = createDeployment(ctx, stack, auth, database, configMap, image)

diff --git a/components/operator/internal/resources/databases/create.go b/components/operator/internal/resources/databases/create.go
@@ -1,6 +1,7 @@
 package databases
 
 import (
+	"github.com/pkg/errors"
 	"strings"
 
 	v1beta1 "github.com/formancehq/operator/api/formance.com/v1beta1"
@@ -51,3 +52,18 @@ func Create(ctx core.Context, owner interface {
 
 	return database, err
 }
+
+const ServiceVersion = "formance.com/module-version"
+
+func SaveModuleVersion(ctx core.Context, database *v1beta1.Database, version string) error {
+	patch := client.MergeFrom(database.DeepCopy())
+	if database.Annotations == nil {
+		database.Annotations = make(map[string]string)
+	}
+	database.Annotations[ServiceVersion] = version
+	return errors.Wrap(ctx.GetClient().Patch(ctx, database, patch), "patching database")
+}
+
+func GetSavedModuleVersion(database *v1beta1.Database) string {
+	return database.Annotations[ServiceVersion]
+}
diff --git a/components/operator/internal/resources/ledgers/controller.go b/components/operator/internal/resources/ledgers/controller.go
@@ -19,6 +19,7 @@ package ledgers
 import (
 	_ "embed"
 	"fmt"
+	"github.com/pkg/errors"
 
 	"github.com/formancehq/operator/api/formance.com/v1beta1"
 	. "github.com/formancehq/operator/internal/core"
@@ -92,11 +93,14 @@ func Reconcile(ctx Context, stack *v1beta1.Stack, ledger *v1beta1.Ledger, versio
 	}
 
 	if database.Status.Ready {
-		if isV2 && ledger.Status.Version != version {
+		if isV2 && databases.GetSavedModuleVersion(database) != version {
 			if err := migrate(ctx, stack, ledger, database, image); err != nil {
 				return err
 			}
-			ledger.Status.Version = version
+
+			if err := databases.SaveModuleVersion(ctx, database, version); err != nil {
+				return errors.Wrap(err, "saving module version in database object")
+			}
 		}
 
 		err = installLedger(ctx, stack, ledger, database, image, isV2)

diff --git a/components/operator/internal/resources/orchestrations/controller.go b/components/operator/internal/resources/orchestrations/controller.go
@@ -60,11 +60,14 @@ func Reconcile(ctx Context, stack *v1beta1.Stack, o *v1beta1.Orchestration, vers
 			return errors.Wrap(err, "resolving image")
 		}
 
-		if IsGreaterOrEqual(version, "v2.0.0-rc.5") && o.Status.Version != version {
+		if IsGreaterOrEqual(version, "v2.0.0-rc.5") && databases.GetSavedModuleVersion(database) != version {
 			if err := jobs.Handle(ctx, o, "migrate", databases.MigrateDatabaseContainer(image, database)); err != nil {
 				return err
 			}
-			o.Status.Version = version
+
+			if err := databases.SaveModuleVersion(ctx, database, version); err != nil {
+				return errors.Wrap(err, "saving module version in database object")
+			}
 		}
 
 		if consumers.Ready() {

diff --git a/components/operator/internal/resources/payments/controller.go b/components/operator/internal/resources/payments/controller.go
@@ -20,6 +20,7 @@ import (
 	_ "embed"
 	"github.com/formancehq/operator/internal/resources/jobs"
 	"github.com/formancehq/operator/internal/resources/registries"
+	"github.com/pkg/errors"
 	batchv1 "k8s.io/api/batch/v1"
 	"net/http"
 
@@ -54,7 +55,7 @@ func Reconcile(ctx Context, stack *v1beta1.Stack, p *v1beta1.Payments, version s
 			return err
 		}
 
-		if p.Status.Version != version {
+		if databases.GetSavedModuleVersion(database) != version {
 			if err := jobs.Handle(ctx, p, "migrate", databases.MigrateDatabaseContainer(image, database,
 				func(m *databases.MigrationConfiguration) {
 					m.AdditionalEnv = []corev1.EnvVar{
@@ -64,7 +65,10 @@ func Reconcile(ctx Context, stack *v1beta1.Stack, p *v1beta1.Payments, version s
 			)); err != nil {
 				return err
 			}
-			p.Status.Version = version
+
+			if err := databases.SaveModuleVersion(ctx, database, version); err != nil {
+				return errors.Wrap(err, "saving module version in database object")
+			}
 		}
 
 		if semver.IsValid(version) && semver.Compare(version, "v1.0.0-alpha") < 0 {

diff --git a/components/operator/internal/resources/reconciliations/controller.go b/components/operator/internal/resources/reconciliations/controller.go
@@ -52,11 +52,14 @@ func Reconcile(ctx Context, stack *v1beta1.Stack, reconciliation *v1beta1.Reconc
 			return errors.Wrap(err, "resolving image")
 		}
 
-		if IsGreaterOrEqual(version, "v2.0.0-rc.5") && reconciliation.Status.Version != version {
+		if IsGreaterOrEqual(version, "v2.0.0-rc.5") && databases.GetSavedModuleVersion(database) != version {
 			if err := jobs.Handle(ctx, reconciliation, "migrate", databases.MigrateDatabaseContainer(image, database)); err != nil {
 				return err
 			}
-			reconciliation.Status.Version = version
+
+			if err := databases.SaveModuleVersion(ctx, database, version); err != nil {
+				return errors.Wrap(err, "saving module version in database object")
+			}
 		}
 
 		if err := createDeployment(ctx, stack, reconciliation, database, authClient, image); err != nil {

diff --git a/components/operator/internal/resources/webhooks/controller.go b/components/operator/internal/resources/webhooks/controller.go
@@ -54,11 +54,13 @@ func Reconcile(ctx Context, stack *v1beta1.Stack, webhooks *v1beta1.Webhooks, ve
 			return errors.Wrap(err, "resolving image")
 		}
 
-		if IsGreaterOrEqual(version, "v2.0.0-rc.5") && webhooks.Status.Version != version {
+		if IsGreaterOrEqual(version, "v2.0.0-rc.5") && databases.GetSavedModuleVersion(database) != version {
 			if err := jobs.Handle(ctx, webhooks, "migrate", databases.MigrateDatabaseContainer(image, database)); err != nil {
 				return err
 			}
-			webhooks.Status.Version = version
+			if err := databases.SaveModuleVersion(ctx, database, version); err != nil {
+				return errors.Wrap(err, "saving module version in database object")
+			}
 		}
 
 		if consumers.Ready() {