feat(operator): add ee modules (#961)

formancehq · Dec 6, 2023 · 4330cf4 · 4330cf4 · vercel · Dec 6, 2023
1 parent 9b02048
commit 4330cf4
Show file tree

Hide file tree

Showing 6 changed files with 399 additions and 13 deletions.
diff --git a/components/fctl/membershipclient/go.sum b/components/fctl/membershipclient/go.sum
diff --git a/components/operator/apis/stack/v1beta3/configuration_types.go b/components/operator/apis/stack/v1beta3/configuration_types.go
@@ -54,18 +54,28 @@ func (in *ConfigurationServicesSpec) List() []string {
 	return ret
 }
 
-func (in *ConfigurationServicesSpec) IsDisabled(service string) bool {
+func (in *ConfigurationServicesSpec) getDisabledProperty(service string) *bool {
 	valueOf := reflect.ValueOf(in).Elem().FieldByName(strcase.ToCamel(service))
 	if valueOf.IsValid() {
 		_, ok := valueOf.Type().FieldByName("CommonServiceProperties")
 		if !ok {
-			return false
+			return nil
 		}
 		commonServiceProperties := valueOf.FieldByName("CommonServiceProperties")
 		properties := commonServiceProperties.Interface().(CommonServiceProperties)
-		return properties.Disabled != nil && *properties.Disabled
+		return properties.Disabled
 	}
-	return false
+	return nil
+}
+
+func (in *ConfigurationServicesSpec) IsExplicitlyDisabled(service string) bool {
+	disabled := in.getDisabledProperty(service)
+	return disabled != nil && *disabled
+}
+
+func (in *ConfigurationServicesSpec) IsExplicitlyEnabled(service string) bool {
+	disabled := in.getDisabledProperty(service)
+	return disabled != nil && !*disabled
 }
 
 // TODO: Handle validation

diff --git a/components/operator/apis/stack/v1beta3/stack_types.go b/components/operator/apis/stack/v1beta3/stack_types.go
@@ -138,13 +138,23 @@ type StackSpec struct {
 	Services StackServicesSpec `json:"services,omitempty"`
 }
 
-func (in *StackServicesSpec) IsDisabled(service string) bool {
+func (in *StackServicesSpec) getDisabledProperty(service string) *bool {
 	valueOf := reflect.ValueOf(in).Elem().FieldByName(strcase.ToCamel(service))
 	if valueOf.IsValid() {
 		properties := valueOf.Interface().(StackServicePropertiesSpec)
-		return properties.Disabled != nil && *properties.Disabled
+		return properties.Disabled
 	}
-	return false
+	return nil
+}
+
+func (in *StackServicesSpec) IsExplicitlyDisabled(service string) bool {
+	disabled := in.getDisabledProperty(service)
+	return disabled != nil && *disabled
+}
+
+func (in *StackServicesSpec) IsExplicitlyEnabled(service string) bool {
+	disabled := in.getDisabledProperty(service)
+	return disabled != nil && !*disabled
 }
 
 type ControlAuthentication struct {

diff --git a/components/operator/internal/modules/gateway/handler.go b/components/operator/internal/modules/gateway/handler.go
@@ -189,7 +189,7 @@ func createCaddyfile(context modules.ServiceInstallConfiguration) string {
 		fallback = *context.Configuration.Spec.Services.Gateway.Fallback
 		redirect = true
 	} else {
-		if !context.IsDisabled("control") {
+		if !context.IsDisabled("control", false) {
 			fallback = fmt.Sprintf("control:%d", servicesMap["control"].Port)
 		}
 	}

diff --git a/components/operator/internal/modules/module.go b/components/operator/internal/modules/module.go
@@ -44,6 +44,21 @@ type Module interface {
 	Versions() map[string]Version
 }
 
+// As standard modules are always enabled, EE modules are, by default disabled.
+// To enable an ee module, it must be explicitely defined with disabled == false,
+// either in global configuration, or per stack
+type EEModule interface {
+	IsEE() bool
+}
+
+func IsEE(m Module) bool {
+	eeModule, ok := m.(EEModule)
+	if ok {
+		ok = eeModule.IsEE()
+	}
+	return ok
+}
+
 type DependsOnAwareModule interface {
 	Module
 	DependsOn() []Module

diff --git a/components/operator/internal/modules/stack.go b/components/operator/internal/modules/stack.go
@@ -69,8 +69,12 @@ type ReconciliationConfig struct {
 	Platform      Platform
 }
 
-func (s *ReconciliationConfig) IsDisabled(module string) bool {
-	return s.Stack.Spec.Services.IsDisabled(module) || s.Configuration.Spec.Services.IsDisabled(module)
+func (s *ReconciliationConfig) IsDisabled(module string, isEE bool) bool {
+	if isEE {
+		return !s.Stack.Spec.Services.IsExplicitlyEnabled(module) && !s.Configuration.Spec.Services.IsExplicitlyEnabled(module)
+	} else {
+		return s.Stack.Spec.Services.IsExplicitlyDisabled(module) || s.Configuration.Spec.Services.IsExplicitlyDisabled(module)
+	}
 }
 
 type StackReconciler struct {
@@ -143,7 +147,7 @@ func (r *StackReconciler) Reconcile(ctx context.Context) (bool, error) {
 
 	if r.Configuration.Spec.LightMode {
 		for _, module := range getSortedModules() {
-			if r.IsDisabled(module.Name()) {
+			if r.IsDisabled(module.Name(), IsEE(module)) {
 				continue
 			}
 			if !r.ready.Contains(module) {
@@ -169,7 +173,7 @@ func (r *StackReconciler) Reconcile(ctx context.Context) (bool, error) {
 	logger.Info("Finalize modules")
 	allReady := true
 	for _, module := range getSortedModules() {
-		if r.IsDisabled(module.Name()) {
+		if r.IsDisabled(module.Name(), IsEE(module)) {
 			continue
 		}
 		if !r.ready.Contains(module) {
@@ -319,7 +323,7 @@ func (r *StackReconciler) prepareModule(ctx context.Context, module Module,
 		return nil
 	}
 
-	if r.IsDisabled(module.Name()) {
+	if r.IsDisabled(module.Name(), IsEE(module)) {
 		return r.scaleDownStackModule(ctx, module)
 	}