Making KMM's configuration be persist during upgrade

Until now, whenever a user upgraded KMM,
the ConfigMap containing the operator
configuration was redeployed,
causing any user changes to be lost.
This commit removes the ConfigMap from KMM's
deploy process, meaning KMM will take hard-coded
default configuration and the user can apply manually the
ConfigMap, meaning it will not be re-deployed during upgrades.

Author: TomerNewman

cmd/manager-hub/main.go

@@ -69,9 +69,9 @@ func main() {
 	logConfig := textlogger.NewConfig()
 	logConfig.AddFlags(flag.CommandLine)
 
-	var configFile string
+	var userConfigMapName string
 
-	flag.StringVar(&configFile, "config", "", "The path to the configuration file.")
+	flag.StringVar(&userConfigMapName, "config", "", "Name of the ConfigMap containing user config.")
 
 	flag.Parse()
 
@@ -80,6 +80,7 @@ func main() {
 	ctrl.SetLogger(logger)
 
 	setupLogger := logger.WithName("setup")
+	operatorNamespace := cmd.GetEnvOrFatalError(constants.OperatorNamespaceEnvVar, setupLogger)
 
 	commit, err := cmd.GitCommit()
 	if err != nil {
@@ -89,15 +90,16 @@ func main() {
 
 	setupLogger.Info("Creating manager", "git commit", commit)
 
-	cfg, err := config.ParseFile(configFile)
+	ctx := ctrl.SetupSignalHandler()
+	cg := config.NewConfigGetter(setupLogger)
+
+	cfg, err := cg.GetConfig(ctx, userConfigMapName, operatorNamespace, true)
 	if err != nil {
-		cmd.FatalError(setupLogger, err, "could not parse the configuration file", "path", configFile)
+		cmd.FatalError(setupLogger, err, "failed to get kmm config")
 	}
 
-	options := cfg.ManagerOptions()
-	options.Scheme = scheme
-
-	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), *options)
+	options := cg.GetManagerOptionsFromConfig(cfg, scheme)
+	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options)
 	if err != nil {
 		cmd.FatalError(setupLogger, err, "unable to create manager")
 	}
@@ -123,8 +125,6 @@ func main() {
 	ctrlLogger := setupLogger.WithValues("name", hub.ManagedClusterModuleReconcilerName)
 	ctrlLogger.Info("Adding controller")
 
-	operatorNamespace := cmd.GetEnvOrFatalError(constants.OperatorNamespaceEnvVar, setupLogger)
-	ctx := ctrl.SetupSignalHandler()
 	mcmr := hub.NewManagedClusterModuleReconciler(
 		client,
 		manifestwork.NewCreator(client, scheme, kernelAPI, operatorNamespace),

cmd/manager/main.go

@@ -22,6 +22,8 @@ import (
 	"os"
 	"strconv"
 
+	"github.com/kubernetes-sigs/kernel-module-management/internal/constants"
+
 	"github.com/kubernetes-sigs/kernel-module-management/internal/buildsign"
 	"github.com/kubernetes-sigs/kernel-module-management/internal/mbsc"
 	"github.com/kubernetes-sigs/kernel-module-management/internal/mic"
@@ -66,9 +68,9 @@ func main() {
 	logConfig := textlogger.NewConfig()
 	logConfig.AddFlags(flag.CommandLine)
 
-	var configFile string
+	var userConfigMapName string
 
-	flag.StringVar(&configFile, "config", "", "The path to the configuration file.")
+	flag.StringVar(&userConfigMapName, "config", "", "Name of the ConfigMap containing user config.")
 
 	flag.Parse()
 
@@ -77,6 +79,7 @@ func main() {
 	ctrl.SetLogger(logger)
 
 	setupLogger := logger.WithName("setup")
+	operatorNamespace := cmd.GetEnvOrFatalError(constants.OperatorNamespaceEnvVar, setupLogger)
 
 	commit, err := cmd.GitCommit()
 	if err != nil {
@@ -94,15 +97,16 @@ func main() {
 
 	setupLogger.Info("Creating manager", "git commit", commit)
 
-	cfg, err := config.ParseFile(configFile)
+	ctx := ctrl.SetupSignalHandler()
+	cg := config.NewConfigGetter(setupLogger)
+
+	cfg, err := cg.GetConfig(ctx, userConfigMapName, operatorNamespace, false)
 	if err != nil {
-		cmd.FatalError(setupLogger, err, "could not parse the configuration file", "path", configFile)
+		cmd.FatalError(setupLogger, err, "failed to get kmm config")
 	}
 
-	options := cfg.ManagerOptions()
-	options.Scheme = scheme
-
-	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), *options)
+	options := cg.GetManagerOptionsFromConfig(cfg, scheme)
+	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options)
 	if err != nil {
 		cmd.FatalError(setupLogger, err, "unable to create manager")
 	}
@@ -146,8 +150,6 @@ func main() {
 		cmd.FatalError(setupLogger, err, "unable to create controller", "name", controllers.ModuleReconcilerName)
 	}
 
-	ctx := ctrl.SetupSignalHandler()
-
 	eventRecorder := mgr.GetEventRecorderFor("kmm")
 
 	workerPodManagerAPI := pod.NewWorkerPodManager(client, workerImage, scheme, &cfg.Worker)

cmd/webhook-server/main.go

@@ -8,6 +8,7 @@ import (
 	kmmv1beta2 "github.com/kubernetes-sigs/kernel-module-management/api/v1beta2"
 	"github.com/kubernetes-sigs/kernel-module-management/internal/cmd"
 	"github.com/kubernetes-sigs/kernel-module-management/internal/config"
+	"github.com/kubernetes-sigs/kernel-module-management/internal/constants"
 	"github.com/kubernetes-sigs/kernel-module-management/internal/webhook"
 	"github.com/kubernetes-sigs/kernel-module-management/internal/webhook/hub"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -33,14 +34,14 @@ func main() {
 	logConfig.AddFlags(flag.CommandLine)
 
 	var (
-		configFile                 string
 		enableModule               bool
 		enableManagedClusterModule bool
 		enableNamespaceDeletion    bool
 		enablePreflightValidation  bool
+		userConfigMapName          string
 	)
 
-	flag.StringVar(&configFile, "config", "", "The path to the configuration file.")
+	flag.StringVar(&userConfigMapName, "config", "", "Name of the ConfigMap containing user config.")
 	flag.BoolVar(&enableModule, "enable-module", false, "Enable the webhook for Module resources")
 	flag.BoolVar(&enableManagedClusterModule, "enable-managedclustermodule", false, "Enable the webhook for ManagedClusterModule resources")
 	flag.BoolVar(&enableNamespaceDeletion, "enable-namespace", false, "Enable the webhook for Namespace deletion")
@@ -61,17 +62,20 @@ func main() {
 	}
 
 	setupLogger.Info("Creating manager", "git commit", commit)
+	operatorNamespace := cmd.GetEnvOrFatalError(constants.OperatorNamespaceEnvVar, setupLogger)
 
-	cfg, err := config.ParseFile(configFile)
+	ctx := ctrl.SetupSignalHandler()
+	cg := config.NewConfigGetter(setupLogger)
+
+	cfg, err := cg.GetConfig(ctx, userConfigMapName, operatorNamespace, false)
 	if err != nil {
-		cmd.FatalError(setupLogger, err, "could not parse the configuration file", "path", configFile)
+		cmd.FatalError(setupLogger, err, "failed to get kmm config")
 	}
 
-	options := cfg.ManagerOptions()
+	options := cg.GetManagerOptionsFromConfig(cfg, scheme)
 	options.LeaderElection = false
-	options.Scheme = scheme
 
-	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), *options)
+	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options)
 	if err != nil {
 		cmd.FatalError(setupLogger, err, "unable to create manager")
 	}
@@ -118,7 +122,7 @@ func main() {
 	}
 
 	setupLogger.Info("starting manager")
-	if err = mgr.Start(ctrl.SetupSignalHandler()); err != nil {
+	if err = mgr.Start(ctx); err != nil {
 		cmd.FatalError(setupLogger, err, "problem running manager")
 	}
 }

config/manager-base/kustomization.yaml

@@ -9,8 +9,5 @@ images:
   newName: gcr.io/k8s-staging-kmm/kernel-module-management-signimage
   newTag: latest
 
-patches:
-- path: manager_config_patch.yaml
-
 configurations:
 - kustomizeconfig.yaml

config/manager-base/manager_config_patch.yaml

@@ -9,10 +9,5 @@ images:
   newName: gcr.io/k8s-staging-kmm/kernel-module-management-operator-hub
   newTag: latest
 
-configMapGenerator:
-- files:
-  - controller_config.yaml
-  name: manager-config
-
-generatorOptions:
-  disableNameSuffixHash: true
+patches:
+- path: manager_hub_config_patch.yaml

config/manager-hub/controller_config.yaml

@@ -0,0 +1,12 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: controller
+  namespace: system
+spec:
+  template:
+    spec:
+      containers:
+        - name: manager
+          args:
+            - "--config=kmm-operator-hub-manager-config"

config/manager-hub/kustomization.yaml

@@ -6,6 +6,7 @@ resources:
 
 patches:
 - path: manager_worker_image_patch.yaml
+- path: manager_config_patch.yaml
 
 images:
 - name: controller
@@ -14,11 +15,3 @@ images:
 - name: worker
   newName: gcr.io/k8s-staging-kmm/kernel-module-management-worker
   newTag: latest
-
-configMapGenerator:
-- files:
-  - controller_config.yaml
-  name: manager-config
-
-generatorOptions:
-  disableNameSuffixHash: true

config/manager-hub/manager_hub_config_patch.yaml

@@ -0,0 +1,12 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: controller
+  namespace: system
+spec:
+  template:
+    spec:
+      containers:
+        - name: manager
+          args:
+            - "--config=kmm-operator-manager-config"