feat: allow removing the default namespace index of an informer (#3623)

Signed-off-by: Antonio Fernandez Alhambra <antonio.alhambra@hivemq.com>

Author: afalhambra-hivemq

docs/content/en/docs/documentation/eventing.md

@@ -348,6 +348,30 @@ See
 also [CaffeineBoundedItemStores](https://github.com/operator-framework/java-operator-sdk/blob/main/caffeine-bounded-cache-support/src/main/java/io/javaoperatorsdk/operator/processing/event/source/cache/CaffeineBoundedItemStores.java)
 for more details.
 
+### Removing the Namespace Index
+
+Informers keep an index from namespace to the resources cached for it. JOSDK never reads that index,
+only the ones registered explicitly through `IndexerResourceCache.addIndexers(..)`, so it can be
+removed to save an entry per cached resource:
+
+```java
+@ControllerConfiguration(informer = @Informer(withoutNamespaceIndex = true))
+public class MyReconciler implements Reconciler<MyCustomResource> { }
+```
+
+The same option is available on `InformerEventSourceConfiguration.Builder` for event sources, and on
+`InformerConfiguration.Builder`.
+
+This matters most for informers that cache a large number of resources, and in particular together
+with a custom [item store](#bounded-caches-for-informers) that keeps only a reduced form of each
+resource: the index is keyed independently of what the store does with the resource itself, so
+shrinking what is cached does not shrink the index.
+
+Note that this takes part in the informer pool identity described below: an event source that
+removes the index does not share an informer with one that keeps it. If two event sources watch the
+same resource type and only one of them sets the option, they end up with two informers, and two
+caches of that resource type, which can cost far more memory than the index ever did.
+
 ### Sharing Informers Between Controllers (Informer Pool)
 
 {{% alert title="Experimental" color="warning" %}}
@@ -374,7 +398,10 @@ Two event sources share an informer when their effective informer configuration
 - the resource type (or the group/version/kind for generic resources),
 - the watched namespace,
 - the label, field and shard selectors,
-- the configured [item store](#bounded-caches-for-informers).
+- the configured [item store](#bounded-caches-for-informers),
+- whether the [namespace index is removed](#removing-the-namespace-index): it cannot be present for
+  one event source and absent for another on one shared informer, so event sources that disagree on
+  it are backed by separate informers.
 
 The `informerListLimit` is intentionally *not* part of this identity: if two otherwise-equivalent
 event sources request a different list limit, the existing informer is reused (a warning is logged

docs/content/en/docs/documentation/operations/configuration.md

@@ -385,6 +385,7 @@ josdk.controller.mycontroller.namespaces=team-a,team-b
 | `josdk.controller.<name>.informer.shard-selector` | `String` | Shard selector for the primary resource informer (alias for `shard-selector`) |
 | `josdk.controller.<name>.informer.list-limit` | `Long` | Page size for paginated informer list requests; omit for no pagination |
 | `josdk.controller.<name>.informer.comparable-resource-versions` | `Boolean` | Whether the resource versions of the primary resource can be treated as integers and thus compared |
+| `josdk.controller.<name>.informer.without-namespace-index` | `Boolean` | Removes the namespace index the informer maintains; defaults to `false`. See [Removing the Namespace Index](../eventing#removing-the-namespace-index) |
 
 #### Retry
 

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

@@ -222,6 +222,18 @@ public ControllerConfigurationOverrider<R> withInformerListLimit(Long informerLi
     return this;
   }
 
+  /**
+   * Whether to remove the namespace index the underlying informer maintains by default. Note that
+   * event sources that disagree on this setting do not share an informer.
+   *
+   * @param withoutNamespaceIndex true to remove the namespace index, false (the default) to keep it
+   * @see io.javaoperatorsdk.operator.api.config.informer.Informer#withoutNamespaceIndex()
+   */
+  public ControllerConfigurationOverrider<R> withoutNamespaceIndex(boolean withoutNamespaceIndex) {
+    config.withoutNamespaceIndex(withoutNamespaceIndex);
+    return this;
+  }
+
   public ControllerConfigurationOverrider<R> replacingNamedDependentResourceConfig(
       String name, Object dependentResourceConfig) {
 

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

@@ -31,6 +31,7 @@
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_COMPARABLE_RESOURCE_VERSION;
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_FOLLOW_CONTROLLER_NAMESPACE_CHANGES;
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_GHOST_RESOURCE_CHECK_INTERVAL_MILLIS;
+import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_WITHOUT_NAMESPACE_INDEX;
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_LONG_VALUE_SET;
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_VALUE_SET;
 
@@ -153,6 +154,23 @@
    */
   boolean comparableResourceVersions() default DEFAULT_COMPARABLE_RESOURCE_VERSION;
 
+  /**
+   * Whether to remove the namespace index that the underlying informer maintains by default.
+   *
+   * <p>The framework never reads that index, it only reads the indexes registered through {@link
+   * io.javaoperatorsdk.operator.processing.event.source.IndexerResourceCache#addIndexers}, so
+   * dropping it saves an entry per cached resource. It is worth setting when the informer caches a
+   * large number of resources and nothing looks them up by namespace, in particular together with a
+   * custom {@link #itemStore()} that keeps only a reduced form of each resource.
+   *
+   * <p>Note that this makes the informer a distinct one for pooling purposes: event sources that
+   * disagree on this setting do not share an informer, because the index cannot be present for one
+   * of them and absent for the other.
+   *
+   * @since 5.7.0
+   */
+  boolean withoutNamespaceIndex() default DEFAULT_WITHOUT_NAMESPACE_INDEX;
+
   /**
    * @deprecated Ghost resource checking is now triggered by the informer's onList callback. This
    *     setting is no longer used.

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

@@ -58,6 +58,7 @@ public class InformerConfiguration<R extends HasMetadata> {
   private Long informerListLimit;
   private FieldSelector fieldSelector;
   private Boolean comparableResourceVersions;
+  private Boolean withoutNamespaceIndex;
 
   protected InformerConfiguration(
       Class<R> resourceClass,
@@ -75,6 +76,7 @@ protected InformerConfiguration(
       Long informerListLimit,
       FieldSelector fieldSelector,
       Boolean comparableResourceVersions,
+      Boolean withoutNamespaceIndex,
       // TODO for removal in major release
       Duration ghostResourceCacheCheckInterval) {
     this(resourceClass, resourceGroupVersionKind);
@@ -91,6 +93,7 @@ protected InformerConfiguration(
     this.informerListLimit = informerListLimit;
     this.fieldSelector = fieldSelector;
     this.comparableResourceVersions = comparableResourceVersions;
+    this.withoutNamespaceIndex = withoutNamespaceIndex;
   }
 
   private InformerConfiguration(Class<R> resourceClass, GroupVersionKind resourceGroupVersionKind) {
@@ -140,6 +143,7 @@ public static <R extends HasMetadata> InformerConfiguration<R>.Builder builder(
             original.informerListLimit,
             original.fieldSelector,
             original.comparableResourceVersions,
+            original.withoutNamespaceIndex,
             null)
         .builder;
   }
@@ -332,6 +336,15 @@ public boolean isComparableResourceVersions() {
     return comparableResourceVersions;
   }
 
+  /**
+   * Whether the namespace index the underlying informer maintains by default is removed.
+   *
+   * @see Informer#withoutNamespaceIndex()
+   */
+  public boolean isWithoutNamespaceIndex() {
+    return withoutNamespaceIndex;
+  }
+
   @SuppressWarnings("UnusedReturnValue")
   public class Builder {
 
@@ -349,6 +362,9 @@ public InformerConfiguration<R> buildForController() {
       if (comparableResourceVersions == null) {
         comparableResourceVersions = DEFAULT_COMPARABLE_RESOURCE_VERSION;
       }
+      if (withoutNamespaceIndex == null) {
+        withoutNamespaceIndex = DEFAULT_WITHOUT_NAMESPACE_INDEX;
+      }
 
       return InformerConfiguration.this;
     }
@@ -364,6 +380,9 @@ public InformerConfiguration<R> build() {
       if (comparableResourceVersions == null) {
         comparableResourceVersions = DEFAULT_COMPARABLE_RESOURCE_VERSION;
       }
+      if (withoutNamespaceIndex == null) {
+        withoutNamespaceIndex = DEFAULT_WITHOUT_NAMESPACE_INDEX;
+      }
 
       return InformerConfiguration.this;
     }
@@ -417,6 +436,7 @@ public InformerConfiguration<R>.Builder initFromAnnotation(
                     .map(f -> new FieldSelector.Field(f.path(), f.value(), f.negated()))
                     .toList()));
         withComparableResourceVersions(informerConfig.comparableResourceVersions());
+        withoutNamespaceIndex(informerConfig.withoutNamespaceIndex());
       }
       return this;
     }
@@ -533,6 +553,16 @@ private static boolean isEmpty(FieldSelector fieldSelector) {
           || fieldSelector.getFields().isEmpty();
     }
 
+    /**
+     * Whether to remove the namespace index the underlying informer maintains by default.
+     *
+     * @see Informer#withoutNamespaceIndex()
+     */
+    public Builder withoutNamespaceIndex(boolean withoutNamespaceIndex) {
+      InformerConfiguration.this.withoutNamespaceIndex = withoutNamespaceIndex;
+      return this;
+    }
+
     public Builder withComparableResourceVersions(boolean comparableResourceVersions) {
       InformerConfiguration.this.comparableResourceVersions = comparableResourceVersions;
       return this;

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

@@ -292,6 +292,11 @@ public Builder<R> withComparableResourceVersion(boolean comparableResourceVersio
       return this;
     }
 
+    public Builder<R> withoutNamespaceIndex(boolean withoutNamespaceIndex) {
+      config.withoutNamespaceIndex(withoutNamespaceIndex);
+      return this;
+    }
+
     @Deprecated(forRemoval = true)
     public Builder<R> withGhostResourceCacheCheckInterval(
         Duration ghostResourceCacheCheckInterval) {
@@ -317,6 +322,7 @@ public void updateFrom(InformerConfiguration<R> informerConfig) {
             .withGenericFilter(informerConfig.getGenericFilter())
             .withInformerListLimit(informerConfig.getInformerListLimit())
             .withComparableResourceVersions(informerConfig.isComparableResourceVersions())
+            .withoutNamespaceIndex(informerConfig.isWithoutNamespaceIndex())
             .withFieldSelector(informerConfig.getFieldSelector());
       }
     }

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

@@ -43,6 +43,7 @@ public final class Constants {
   public static final String CONTROLLER_NAME = "controller.name";
   public static final boolean DEFAULT_FOLLOW_CONTROLLER_NAMESPACE_CHANGES = true;
   public static final boolean DEFAULT_COMPARABLE_RESOURCE_VERSION = true;
+  public static final boolean DEFAULT_WITHOUT_NAMESPACE_INDEX = false;
 
   @Deprecated(forRemoval = true)
   public static final long DEFAULT_GHOST_RESOURCE_CHECK_INTERVAL_MILLIS = 3 * 60 * 1000;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerManager.java

@@ -181,7 +181,8 @@ private InformerClassifier<R> getClassifier(String namespaceIdentifier) {
         configuration.getInformerConfig().getResourceGroupVersionKind(),
         configuration.getInformerConfig().getFieldSelector(),
         configuration.getInformerConfig().getInformerListLimit(),
-        configuration.getInformerConfig().getItemStore());
+        configuration.getInformerConfig().getItemStore(),
+        configuration.getInformerConfig().isWithoutNamespaceIndex());
   }
 
   private KubernetesClient getTargetClient() {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/pool/AbstractInformerPool.java

@@ -71,7 +71,7 @@ public void setConfigurationService(ConfigurationService configurationService) {
    */
   public abstract long numberOfInformersForResource(Class<? extends HasMetadata> resourceClass);
 
-  @SuppressWarnings({"rawtypes", "unchecked"})
+  @SuppressWarnings({"rawtypes", "unchecked", "resource"})
   protected SharedIndexInformer createInformer(InformerClassifier<?> classifier) {
     var client = classifier.client();
 
@@ -116,6 +116,11 @@ protected SharedIndexInformer createInformer(InformerClassifier<?> classifier) {
 
     Optional.ofNullable(classifier.itemStore()).ifPresent(informer::itemStore);
 
+    if (classifier.withoutNamespaceIndex()) {
+      // the framework only reads the indexes registered through the resource cache, never this one
+      informer.removeNamespaceIndex();
+    }
+
     configurationService
         .getInformerStoppedHandler()
         .ifPresent(

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/pool/DefaultInformerPool.java

@@ -43,6 +43,14 @@ public <R extends HasMetadata> SharedIndexInformer<R> getInformer(
     synchronized (this) {
       var pooled = informers.get(classifier);
       if (pooled == null) {
+        if (informers.keySet().stream()
+            .anyMatch(existing -> existing.differsOnlyByNamespaceIndex(classifier))) {
+          log.warn(
+              "Creating a second informer for classifier {} that differs from an existing one only"
+                  + " by withoutNamespaceIndex, so the resource type is cached twice. Set the"
+                  + " option the same way on both to share one informer.",
+              classifier);
+        }
         informer = createInformer(classifier);
         informers.put(classifier, new PooledInformer(informer, new AtomicInteger(1)));
         log.debug(