feat: retrieve ConfigurationService from ConfigurationServiceProvider

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -14,6 +14,8 @@
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.Version;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
+import io.javaoperatorsdk.operator.api.config.ConfigurationServiceOverrider;
+import io.javaoperatorsdk.operator.api.config.ConfigurationServiceProvider;
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.config.ControllerConfigurationOverrider;
 import io.javaoperatorsdk.operator.api.config.ExecutorServiceManager;
@@ -25,14 +27,33 @@
 public class Operator implements LifecycleAware {
   private static final Logger log = LoggerFactory.getLogger(Operator.class);
   private final KubernetesClient kubernetesClient;
-  private final ConfigurationService configurationService;
   private final ControllerManager controllers = new ControllerManager();
 
+  public Operator() {
+    this(new DefaultKubernetesClient(), ConfigurationServiceProvider.instance());
+  }
+
+  public Operator(KubernetesClient kubernetesClient) {
+    this(kubernetesClient, ConfigurationServiceProvider.instance());
+  }
 
+  /**
+   * @deprecated Use {@link #Operator(Consumer)} instead
+   */
+  @Deprecated
   public Operator(ConfigurationService configurationService) {
     this(new DefaultKubernetesClient(), configurationService);
   }
 
+  public Operator(Consumer<ConfigurationServiceOverrider> overrider) {
+    this(new DefaultKubernetesClient(), overrider);
+  }
+
+  public Operator(KubernetesClient client, Consumer<ConfigurationServiceOverrider> overrider) {
+    this(client);
+    ConfigurationServiceProvider.overrideCurrent(overrider);
+  }
+
   /**
    * Note that Operator by default closes the client on stop, this can be changed using
    * {@link ConfigurationService}
@@ -42,7 +63,7 @@ public Operator(ConfigurationService configurationService) {
    */
   public Operator(KubernetesClient kubernetesClient, ConfigurationService configurationService) {
     this.kubernetesClient = kubernetesClient;
-    this.configurationService = configurationService;
+    ConfigurationServiceProvider.set(configurationService);
   }
 
   /** Adds a shutdown hook that automatically calls {@link #stop()} ()} when the app shuts down. */
@@ -54,10 +75,6 @@ public KubernetesClient getKubernetesClient() {
     return kubernetesClient;
   }
 
-  public ConfigurationService getConfigurationService() {
-    return configurationService;
-  }
-
   public List<Controller> getControllers() {
     return new ArrayList<>(controllers.controllers.values());
   }
@@ -70,7 +87,7 @@ public List<Controller> getControllers() {
   public void start() {
     controllers.shouldStart();
 
-    final var version = configurationService.getVersion();
+    final var version = ConfigurationServiceProvider.instance().getVersion();
     log.info(
         "Operator SDK {} (commit: {}) built on {} starting...",
         version.getSdkVersion(),
@@ -80,12 +97,13 @@ public void start() {
     final var clientVersion = Version.clientVersion();
     log.info("Client version: {}", clientVersion);
 
-    ExecutorServiceManager.init(configurationService);
+    ExecutorServiceManager.init();
     controllers.start();
   }
 
   @Override
   public void stop() throws OperatorException {
+    final var configurationService = ConfigurationServiceProvider.instance();
     log.info(
         "Operator SDK {} is shutting down...", configurationService.getVersion().getSdkVersion());
 
@@ -107,7 +125,8 @@ public void stop() throws OperatorException {
    */
   public <R extends HasMetadata> void register(Reconciler<R> reconciler)
       throws OperatorException {
-    final var controllerConfiguration = configurationService.getConfigurationFor(reconciler);
+    final var controllerConfiguration =
+        ConfigurationServiceProvider.instance().getConfigurationFor(reconciler);
     register(reconciler, controllerConfiguration);
   }
 
@@ -132,7 +151,8 @@ public <R extends HasMetadata> void register(Reconciler<R> reconciler,
           "Cannot register reconciler with name " + reconciler.getClass().getCanonicalName() +
               " reconciler named " + ReconcilerUtils.getNameFor(reconciler)
               + " because its configuration cannot be found.\n" +
-              " Known reconcilers are: " + configurationService.getKnownReconcilerNames());
+              " Known reconcilers are: "
+              + ConfigurationServiceProvider.instance().getKnownReconcilerNames());
     }
 
     final var controller = new Controller<>(reconciler, configuration, kubernetesClient);
@@ -158,7 +178,8 @@ public <R extends HasMetadata> void register(Reconciler<R> reconciler,
    */
   public <R extends HasMetadata> void register(Reconciler<R> reconciler,
       Consumer<ControllerConfigurationOverrider<R>> configOverrider) {
-    final var controllerConfiguration = configurationService.getConfigurationFor(reconciler);
+    final var controllerConfiguration =
+        ConfigurationServiceProvider.instance().getConfigurationFor(reconciler);
     var configToOverride = ControllerConfigurationOverrider.override(controllerConfiguration);
     configOverrider.accept(configToOverride);
     register(reconciler, configToOverride.build());

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AbstractConfigurationService.java

@@ -26,6 +26,7 @@ protected <R extends HasMetadata> void replace(ControllerConfiguration<R> config
     put(config, false);
   }
 
+  @SuppressWarnings("unchecked")
   private <R extends HasMetadata> void put(
       ControllerConfiguration<R> config, boolean failIfExisting) {
     final var name = config.getName();
@@ -36,7 +37,6 @@ private <R extends HasMetadata> void put(
       }
     }
     configurations.put(name, config);
-    config.setConfigurationService(this);
   }
 
   protected <R extends HasMetadata> void throwExceptionOnNameCollision(
@@ -50,6 +50,7 @@ protected <R extends HasMetadata> void throwExceptionOnNameCollision(
             + newReconcilerClassName);
   }
 
+  @SuppressWarnings("unchecked")
   @Override
   public <R extends HasMetadata> ControllerConfiguration<R> getConfigurationFor(
       Reconciler<R> reconciler) {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AnnotationControllerConfiguration.java

@@ -26,7 +26,6 @@ public class AnnotationControllerConfiguration<R extends HasMetadata>
 
   protected final Reconciler<R> reconciler;
   private final ControllerConfiguration annotation;
-  private ConfigurationService service;
   private List<DependentResourceSpec<?, ?>> specs;
 
   public AnnotationControllerConfiguration(Reconciler<R> reconciler) {
@@ -77,16 +76,6 @@ public String getLabelSelector() {
     return valueOrDefault(annotation, ControllerConfiguration::labelSelector, "");
   }
 
-  @Override
-  public ConfigurationService getConfigurationService() {
-    return service;
-  }
-
-  @Override
-  public void setConfigurationService(ConfigurationService service) {
-    this.service = service;
-  }
-
   @Override
   public String getAssociatedReconcilerClassName() {
     return reconciler.getClass().getCanonicalName();
@@ -172,8 +161,8 @@ public static <T> T valueOrDefault(
                   kubeDependent,
                   KubernetesDependent::addOwnerReference,
                   KubernetesDependent.ADD_OWNER_REFERENCE_DEFAULT);
-          config = new KubernetesDependentResourceConfig(
-              addOwnerReference, namespaces, labelSelector, getConfigurationService());
+          config =
+              new KubernetesDependentResourceConfig(addOwnerReference, namespaces, labelSelector);
         }
         specs.add(new DependentResourceSpec(dependentType, config));
       }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java

@@ -2,12 +2,12 @@
 
 import java.util.Set;
 import java.util.concurrent.ExecutorService;
+import java.util.function.Consumer;
 
-import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.Config;
 import io.javaoperatorsdk.operator.api.monitoring.Metrics;
-import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 
+@SuppressWarnings("unused")
 public class ConfigurationServiceOverrider {
   private final ConfigurationService original;
   private Metrics metrics;
@@ -19,8 +19,7 @@ public class ConfigurationServiceOverrider {
   private boolean closeClientOnStop;
   private ExecutorService executorService = null;
 
-  public ConfigurationServiceOverrider(
-      ConfigurationService original) {
+  ConfigurationServiceOverrider(ConfigurationService original) {
     this.original = original;
     this.clientConfig = original.getClientConfiguration();
     this.checkCR = original.checkCRDAndValidateLocalModel();
@@ -73,26 +72,12 @@ public ConfigurationServiceOverrider withExecutorService(ExecutorService executo
   }
 
   public ConfigurationService build() {
-    return new ConfigurationService() {
-      @Override
-      public <R extends HasMetadata> ControllerConfiguration<R> getConfigurationFor(
-          Reconciler<R> reconciler) {
-        ControllerConfiguration<R> controllerConfiguration =
-            original.getConfigurationFor(reconciler);
-        controllerConfiguration.setConfigurationService(this);
-        return controllerConfiguration;
-      }
-
+    return new BaseConfigurationService(original.getVersion()) {
       @Override
       public Set<String> getKnownReconcilerNames() {
         return original.getKnownReconcilerNames();
       }
 
-      @Override
-      public Version getVersion() {
-        return original.getVersion();
-      }
-
       @Override
       public Config getClientConfiguration() {
         return clientConfig;
@@ -133,12 +118,16 @@ public ExecutorService getExecutorService() {
         if (executorService != null) {
           return executorService;
         } else {
-          return ConfigurationService.super.getExecutorService();
+          return super.getExecutorService();
         }
       }
     };
   }
 
+  /**
+   * @deprecated Use {@link ConfigurationServiceProvider#overrideCurrent(Consumer)} instead
+   */
+  @Deprecated(since = "2.2.0")
   public static ConfigurationServiceOverrider override(ConfigurationService original) {
     return new ConfigurationServiceOverrider(original);
   }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceProvider.java

@@ -0,0 +1,67 @@
+package io.javaoperatorsdk.operator.api.config;
+
+import java.util.function.Consumer;
+
+public class ConfigurationServiceProvider {
+  static final ConfigurationService DEFAULT =
+      new BaseConfigurationService(Utils.loadFromProperties());
+  private static ConfigurationService instance;
+  private static ConfigurationService defaultConfigurationService = DEFAULT;
+  private static boolean alreadyConfigured = false;
+
+  private ConfigurationServiceProvider() {}
+
+  public synchronized static ConfigurationService instance() {
+    if (instance == null) {
+      set(defaultConfigurationService);
+    }
+    return instance;
+  }
+
+  public synchronized static void set(ConfigurationService instance) {
+    set(instance, false);
+  }
+
+  private static void set(ConfigurationService instance, boolean overriding) {
+    final var current = ConfigurationServiceProvider.instance;
+    if (!overriding) {
+      if (current != null && !current.equals(instance)) {
+        throw new IllegalStateException(
+            "A ConfigurationService has already been set and cannot be set again. Current: "
+                + current.getClass().getCanonicalName());
+      }
+    } else {
+      if (alreadyConfigured) {
+        throw new IllegalStateException(
+            "The ConfigurationService has already been overridden once and cannot be changed again. Current: "
+                + current.getClass().getCanonicalName());
+      } else {
+        alreadyConfigured = true;
+      }
+    }
+
+    ConfigurationServiceProvider.instance = instance;
+  }
+
+  public synchronized static void overrideCurrent(
+      Consumer<ConfigurationServiceOverrider> overrider) {
+    final var toOverride =
+        new ConfigurationServiceOverrider(ConfigurationServiceProvider.instance());
+    overrider.accept(toOverride);
+    ConfigurationServiceProvider.set(toOverride.build(), true);
+  }
+
+  public synchronized static void setDefault(ConfigurationService defaultConfigurationService) {
+    ConfigurationServiceProvider.defaultConfigurationService = defaultConfigurationService;
+  }
+
+  synchronized static ConfigurationService getDefault() {
+    return defaultConfigurationService;
+  }
+
+  public synchronized static void reset() {
+    defaultConfigurationService = DEFAULT;
+    instance = null;
+    alreadyConfigured = false;
+  }
+}

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

@@ -58,4 +58,8 @@ default ResourceEventFilter<R> getEventFilter() {
   default Optional<Duration> reconciliationMaxInterval() {
     return Optional.of(Duration.ofHours(10L));
   }
+
+  default ConfigurationService getConfigurationService() {
+    return ConfigurationServiceProvider.instance();
+  }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfigurationOverrider.java

@@ -135,7 +135,6 @@ public ControllerConfiguration<R> build() {
         customResourcePredicate,
         original.getResourceClass(),
         reconciliationMaxInterval,
-        original.getConfigurationService(),
         dependentResourceSpecs);
   }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/DefaultControllerConfiguration.java

@@ -10,6 +10,7 @@
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilter;
 
+@SuppressWarnings("rawtypes")
 public class DefaultControllerConfiguration<R extends HasMetadata>
     extends DefaultResourceConfiguration<R>
     implements ControllerConfiguration<R> {
@@ -37,7 +38,6 @@ public DefaultControllerConfiguration(
       ResourceEventFilter<R> resourceEventFilter,
       Class<R> resourceClass,
       Duration reconciliationMaxInterval,
-      ConfigurationService service,
       List<DependentResourceSpec<?, ?>> dependents) {
     super(labelSelector, resourceClass, namespaces);
     this.associatedControllerClassName = associatedControllerClassName;
@@ -52,7 +52,6 @@ public DefaultControllerConfiguration(
             : retryConfiguration;
     this.resourceEventFilter = resourceEventFilter;
 
-    setConfigurationService(service);
     this.dependents = dependents != null ? dependents : Collections.emptyList();
   }
 
@@ -86,16 +85,6 @@ public RetryConfiguration getRetryConfiguration() {
     return retryConfiguration;
   }
 
-
-  @Override
-  public void setConfigurationService(ConfigurationService service) {
-    if (getConfigurationService() != null) {
-      throw new IllegalStateException("A ConfigurationService is already associated with '" + name
-          + "' ControllerConfiguration. Cannot change it once set!");
-    }
-    super.setConfigurationService(service);
-  }
-
   @Override
   public ResourceEventFilter<R> getEventFilter() {
     return resourceEventFilter;