feat: process the DR configuration when the spec is created

Signed-off-by: Chris Laprun <claprun@redhat.com>

Author: metacosm

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

@@ -17,6 +17,7 @@
 import io.javaoperatorsdk.operator.OperatorException;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.config.Utils.Configurator;
+import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceConfigurationResolver;
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
 import io.javaoperatorsdk.operator.api.config.workflow.WorkflowSpec;
 import io.javaoperatorsdk.operator.api.reconciler.Constants;
@@ -224,7 +225,13 @@ private static List<DependentResourceSpec> dependentResources(
           Utils.instantiate(dependent.reconcilePrecondition(), Condition.class, context),
           Utils.instantiate(dependent.deletePostcondition(), Condition.class, context),
           Utils.instantiate(dependent.activationCondition(), Condition.class, context),
-          eventSourceName, null); // todo: actually compute the configuration
+          eventSourceName);
+
+      // extract potential configuration
+      final var configuration = DependentResourceConfigurationResolver
+          .extractConfigurationFromConfigured(spec, parent, dependentType);
+      spec.setConfiguration(configuration);
+
       specsMap.put(dependentName, spec);
     }
     return specsMap.values().stream().toList();

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

@@ -6,6 +6,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
+import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
 import io.javaoperatorsdk.operator.api.config.workflow.WorkflowSpec;
 import io.javaoperatorsdk.operator.api.reconciler.MaxReconciliationInterval;
 import io.javaoperatorsdk.operator.processing.event.rate.LinearRateLimiter;
@@ -100,4 +101,5 @@ default String fieldManager() {
     return getName();
   }
 
+  <C> C getConfigurationFor(DependentResourceSpec<?, P, C> spec);
 }

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

@@ -9,7 +9,6 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.informers.cache.ItemStore;
-import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceConfigurationProvider;
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
 import io.javaoperatorsdk.operator.api.config.workflow.WorkflowSpec;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
@@ -22,8 +21,7 @@
 @SuppressWarnings("rawtypes")
 public class ResolvedControllerConfiguration<P extends HasMetadata>
     extends DefaultResourceConfiguration<P>
-    implements io.javaoperatorsdk.operator.api.config.ControllerConfiguration<P>,
-    DependentResourceConfigurationProvider {
+    implements io.javaoperatorsdk.operator.api.config.ControllerConfiguration<P> {
 
   private final String name;
   private final boolean generationAware;
@@ -168,8 +166,15 @@ public ConfigurationService getConfigurationService() {
   }
 
   @Override
-  public Object getConfigurationFor(DependentResourceSpec spec) {
-    return configurations.get(spec);
+  @SuppressWarnings("unchecked")
+  public <C> C getConfigurationFor(DependentResourceSpec<?, P, C> spec) {
+    // first check if there's an overridden configuration at the controller level
+    var config = configurations.get(spec);
+    if (config == null) {
+      // if not, check the spec for configuration
+      config = spec.getConfiguration().orElse(null);
+    }
+    return (C) config;
   }
 
   @Override

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

@@ -7,6 +7,7 @@
 
 public interface ConfigurationConverter<A extends Annotation, C> {
 
-  C configFrom(A configAnnotation, ControllerConfiguration<?> parentConfiguration,
-      DependentResourceSpec<?, ?, ?> spec, DependentResource<?, ?> dependentResource);
+  C configFrom(A configAnnotation, DependentResourceSpec<?, ?, C> spec,
+      ControllerConfiguration<?> parentConfiguration,
+      Class<? extends DependentResource<?, ?>> dependentResourceClass);
 }

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

@@ -8,7 +8,6 @@
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.config.Utils;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
-import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.ConfiguredDependentResource;
 
 @SuppressWarnings({"rawtypes", "unchecked"})
 public class DependentResourceConfigurationResolver {
@@ -20,34 +19,11 @@ private DependentResourceConfigurationResolver() {}
   private static final Map<Class<? extends ConfigurationConverter>, ConfigurationConverter> knownConverters =
       new HashMap<>();
 
-  public static <C extends ControllerConfiguration<? extends HasMetadata>> void configure(
-      DependentResource dependentResource, DependentResourceSpec spec, C parentConfiguration) {
-    if (dependentResource instanceof ConfiguredDependentResource configurator) {
-      final var config = configurationFor(spec, parentConfiguration, dependentResource);
-      configurator.configureWith(config);
-    }
-  }
-
-  public static <C extends ControllerConfiguration<? extends HasMetadata>> Object configurationFor(
-      DependentResourceSpec spec, C parentConfiguration, DependentResource dependentResource) {
 
-    // first check if the parent configuration has potentially already resolved the configuration
-    if (parentConfiguration instanceof DependentResourceConfigurationProvider provider) {
-      final var configuration = provider.getConfigurationFor(spec);
-      if (configuration != null) {
-        return configuration;
-      }
-    }
-
-    // find Configured-annotated class if it exists
-    return extractConfigurationFromConfigured(spec, parentConfiguration, dependentResource);
-  }
-
-  protected static <C extends ControllerConfiguration<? extends HasMetadata>> Object extractConfigurationFromConfigured(
+  public static <C extends ControllerConfiguration<?>> Object extractConfigurationFromConfigured(
       DependentResourceSpec spec,
       C parentConfiguration,
-      DependentResource dependentResource) {
-    Class<? extends DependentResource> dependentResourceClass = spec.getDependentResourceClass();
+      Class<? extends DependentResource> dependentResourceClass) {
     var converterAnnotationPair = converters.get(dependentResourceClass);
 
     Annotation configAnnotation;
@@ -78,7 +54,8 @@ protected static <C extends ControllerConfiguration<? extends HasMetadata>> Obje
 
     // always called even if the annotation is null so that implementations can provide default
     // values
-    return converter.configFrom(configAnnotation, parentConfiguration, spec, dependentResource);
+    return converter.configFrom(configAnnotation, spec, parentConfiguration,
+        dependentResourceClass);
   }
 
   private static ConfiguredClassPair getConfigured(

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

@@ -25,12 +25,12 @@ public class DependentResourceSpec<R, P extends HasMetadata, C> {
   private final Condition<?, ?> activationCondition;
 
   private final String useEventSourceWithName;
-  private final C nullableConfiguation;
+  private C nullableConfiguation;
 
   public DependentResourceSpec(Class<? extends DependentResource<R, P>> dependentResourceClass,
       String name, Set<String> dependsOn, Condition<?, ?> readyCondition,
       Condition<?, ?> reconcileCondition, Condition<?, ?> deletePostCondition,
-      Condition<?, ?> activationCondition, String useEventSourceWithName, C nullableConfiguration) {
+      Condition<?, ?> activationCondition, String useEventSourceWithName) {
     this.dependentResourceClass = dependentResourceClass;
     this.name = name;
     this.dependsOn = dependsOn;
@@ -39,7 +39,6 @@ public DependentResourceSpec(Class<? extends DependentResource<R, P>> dependentR
     this.deletePostCondition = deletePostCondition;
     this.activationCondition = activationCondition;
     this.useEventSourceWithName = useEventSourceWithName;
-    this.nullableConfiguation = nullableConfiguration;
   }
 
   public Class<? extends DependentResource<R, P>> getDependentResourceClass() {
@@ -104,4 +103,8 @@ public Optional<String> getUseEventSourceWithName() {
   public Optional<C> getConfiguration() {
     return Optional.ofNullable(nullableConfiguation);
   }
+
+  public void setConfiguration(C configuration) {
+    this.nullableConfiguation = configuration;
+  }
 }

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

@@ -12,6 +12,8 @@
 import io.javaoperatorsdk.operator.api.config.ResourceConfiguration;
 import io.javaoperatorsdk.operator.api.config.Utils;
 import io.javaoperatorsdk.operator.processing.GroupVersionKind;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.GenericKubernetesDependentResource;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.InformerConfigSpec;
 import io.javaoperatorsdk.operator.processing.event.source.PrimaryToSecondaryMapper;
 import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
 import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
@@ -152,7 +154,7 @@ static boolean inheritsNamespacesFromController(Set<String> namespaces) {
   class InformerConfigurationBuilder<R extends HasMetadata> {
 
     private final Class<R> resourceClass;
-    private final GroupVersionKind groupVersionKind;
+    private GroupVersionKind groupVersionKind;
     private final Class<? extends HasMetadata> primaryResourceClass;
     private String name;
     private PrimaryToSecondaryMapper<?> primaryToSecondaryMapper;
@@ -191,6 +193,23 @@ public InformerConfigurationBuilder<R> withName(String name) {
       return this;
     }
 
+    @SuppressWarnings("unchecked")
+    public InformerConfigurationBuilder<R> withConfig(InformerConfigSpec<R> spec) {
+      groupVersionKind = spec.groupVersionKind();
+      if (groupVersionKind != null
+          && !GenericKubernetesResource.class.isAssignableFrom(resourceClass)) {
+        throw new IllegalStateException("If GroupVersionKind is set, the resource type must be "
+            + GenericKubernetesDependentResource.class.getSimpleName());
+      }
+
+      return withGenericFilter(spec.genericFilter())
+          .withLabelSelector(spec.labelSelector())
+          .withNamespaces(spec.namespaces())
+          .withOnAddFilter(spec.onAddFilter())
+          .withOnUpdateFilter(spec.onUpdateFilter())
+          .withOnDeleteFilter(spec.onDeleteFilter());
+    }
+
     public <P extends HasMetadata> InformerConfigurationBuilder<R> withPrimaryToSecondaryMapper(
         PrimaryToSecondaryMapper<P> primaryToSecondaryMapper) {
       this.primaryToSecondaryMapper = primaryToSecondaryMapper;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/DependentResourceFactory.java

@@ -3,19 +3,28 @@
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.config.Utils;
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
-
-import static io.javaoperatorsdk.operator.api.config.dependent.DependentResourceConfigurationResolver.configure;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.ConfiguredDependentResource;
 
 @SuppressWarnings({"rawtypes", "unchecked"})
 public interface DependentResourceFactory<C extends ControllerConfiguration<?>> {
 
   DependentResourceFactory DEFAULT = new DependentResourceFactory() {};
 
-  default DependentResource createFrom(DependentResourceSpec spec, C configuration) {
+  default DependentResource createFrom(DependentResourceSpec spec, C controllerConfiguration) {
     final var dependentResourceClass = spec.getDependentResourceClass();
     return Utils.instantiateAndConfigureIfNeeded(dependentResourceClass,
         DependentResource.class,
-        Utils.contextFor(configuration, dependentResourceClass, Dependent.class),
-        (instance) -> configure(instance, spec, configuration));
+        Utils.contextFor(controllerConfiguration, dependentResourceClass, Dependent.class),
+        (instance) -> configure(instance, spec, controllerConfiguration));
+  }
+
+  default void configure(DependentResource instance, DependentResourceSpec spec,
+      C controllerConfiguration) {
+    if (instance instanceof ConfiguredDependentResource configurable) {
+      final var config = controllerConfiguration.getConfigurationFor(spec);
+      if (config != null) {
+        configurable.configureWith(config);
+      }
+    }
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/ConfiguredDependentResource.java

@@ -2,6 +2,7 @@
 
 import java.util.Optional;
 
+
 public interface ConfiguredDependentResource<C> {
   void configureWith(C config);
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/InformerConfigSpec.java

@@ -0,0 +1,103 @@
+package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
+
+import java.util.Set;
+
+import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.Constants;
+import io.javaoperatorsdk.operator.processing.GroupVersionKind;
+import io.javaoperatorsdk.operator.processing.event.source.PrimaryToSecondaryMapper;
+import io.javaoperatorsdk.operator.processing.event.source.SecondaryToPrimaryMapper;
+import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
+import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
+import io.javaoperatorsdk.operator.processing.event.source.filter.OnDeleteFilter;
+import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
+
+
+public class InformerConfigSpec<R> {
+
+  private final String name;
+  private final OnAddFilter<R> onAddFilter;
+  private final OnUpdateFilter<R> onUpdateFilter;
+  private final OnDeleteFilter<R> onDeleteFilter;
+  private final GenericFilter<R> genericFilter;
+  private final Set<String> namespaces;
+  private final String labelSelector;
+  private final GroupVersionKind groupVersionKind;
+  private final boolean followControllerNamespacesOnChange;
+  private final SecondaryToPrimaryMapper<R> secondaryToPrimaryMapper;
+  private final PrimaryToSecondaryMapper<?> primaryToSecondaryMapper;
+
+  InformerConfigSpec(String name, SecondaryToPrimaryMapper<R> secondaryToPrimaryMapper) {
+    this(name, Constants.SAME_AS_CONTROLLER_NAMESPACES_SET, null,
+        InformerConfiguration.DEFAULT_FOLLOW_CONTROLLER_NAMESPACES_ON_CHANGE, null,
+        null, null, null, null, secondaryToPrimaryMapper, null);
+  }
+
+  public InformerConfigSpec(String name,
+      Set<String> namespaces,
+      String labelSelector,
+      boolean followControllerNamespacesOnChange,
+      OnAddFilter<R> onAddFilter,
+      OnUpdateFilter<R> onUpdateFilter,
+      OnDeleteFilter<R> onDeleteFilter,
+      GenericFilter<R> genericFilter, GroupVersionKind groupVersionKind,
+      SecondaryToPrimaryMapper<R> secondaryToPrimaryMapper,
+      PrimaryToSecondaryMapper<?> primaryToSecondaryMapper) {
+    this.name = name;
+    this.namespaces = namespaces;
+    this.labelSelector = labelSelector;
+    this.followControllerNamespacesOnChange = followControllerNamespacesOnChange;
+    this.onAddFilter = onAddFilter;
+    this.onUpdateFilter = onUpdateFilter;
+    this.onDeleteFilter = onDeleteFilter;
+    this.genericFilter = genericFilter;
+    this.groupVersionKind = groupVersionKind;
+    this.secondaryToPrimaryMapper = secondaryToPrimaryMapper;
+    this.primaryToSecondaryMapper = primaryToSecondaryMapper;
+  }
+
+  public String name() {
+    return name;
+  }
+
+  public GroupVersionKind groupVersionKind() {
+    return groupVersionKind;
+  }
+
+  public Set<String> namespaces() {
+    return namespaces;
+  }
+
+  public String labelSelector() {
+    return labelSelector;
+  }
+
+  public boolean followControllerNamespacesOnChange() {
+    return followControllerNamespacesOnChange;
+  }
+
+  @SuppressWarnings("rawtypes")
+  public OnAddFilter onAddFilter() {
+    return onAddFilter;
+  }
+
+  public OnUpdateFilter<R> onUpdateFilter() {
+    return onUpdateFilter;
+  }
+
+  public OnDeleteFilter<R> onDeleteFilter() {
+    return onDeleteFilter;
+  }
+
+  public GenericFilter<R> genericFilter() {
+    return genericFilter;
+  }
+
+  public SecondaryToPrimaryMapper<R> secondaryToPrimaryMapper() {
+    return secondaryToPrimaryMapper;
+  }
+
+  public PrimaryToSecondaryMapper<?> primaryToSecondaryMapper() {
+    return primaryToSecondaryMapper;
+  }
+}