docs: item store on @ControllerConfiguration (#1942)

Co-authored-by: Chris Laprun <[email protected]>

Author: csviri

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResourceConfiguration.java

@@ -10,6 +10,7 @@
 import io.javaoperatorsdk.operator.OperatorException;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.reconciler.Constants;
+import io.javaoperatorsdk.operator.processing.event.source.cache.BoundedItemStore;
 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.OnUpdateFilter;
@@ -125,19 +126,21 @@ default Set<String> getEffectiveNamespaces() {
   }
 
   /**
-   * Replaces the item store in informer. See underling <a href=
-   * "https://github.com/fabric8io/kubernetes-client/blob/43b67939fde91046ab7fb0c362f500c2b46eb59e/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/informers/impl/DefaultSharedIndexInformer.java#L273">
-   * method</a> in fabric8 client informer implementation.
+   * Replaces the item store in informer. See underlying <a href=
+   * "https://github.com/fabric8io/kubernetes-client/blob/43b67939fde91046ab7fb0c362f500c2b46eb59e/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/informers/impl/DefaultSharedIndexInformer.java#L273">method</a>
+   * in fabric8 client informer implementation.
    *
-   * The main goal, is to be able to use limited caches.
+   * <p>
+   * The main goal, is to be able to use limited caches or provide any custom implementation.
+   * </p>
    *
-   * See {@link io.javaoperatorsdk.operator.processing.event.source.cache.BoundedItemStore} and
-   * <a href=
-   * "https://github.com/operator-framework/java-operator-sdk/blob/d6eda0138dba6d93c0ff22a5ffcaa7663fa65ca2/caffein-bounded-cache-support/src/main/java/io/javaoperatorsdk/operator/processing/event/source/cache/CaffeinBoundedCache.java">
-   * CaffeinBoundedCache</a>
+   * <p>
+   * See {@link BoundedItemStore} and <a href=
+   * "https://github.com/operator-framework/java-operator-sdk/blob/main/caffeine-bounded-cache-support/src/main/java/io/javaoperatorsdk/operator/processing/event/source/cache/CaffeineBoundedCache.java">CaffeineBoundedCache</a>
+   * </p>
    *
-   * @return Optional ItemStore implementation. If present this item store will be used inside the
-   *         informers.
+   * @return Optional {@link ItemStore} implementation. If present this item store will be used by
+   *         the informers.
    */
   default Optional<ItemStore<R>> getItemStore() {
     return Optional.empty();

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ControllerConfiguration.java

@@ -10,6 +10,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent;
 import io.javaoperatorsdk.operator.processing.event.rate.LinearRateLimiter;
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter;
+import io.javaoperatorsdk.operator.processing.event.source.cache.BoundedItemStore;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
@@ -128,5 +129,22 @@ MaxReconciliationInterval maxReconciliationInterval() default @MaxReconciliation
    */
   Class<? extends RateLimiter> rateLimiter() default LinearRateLimiter.class;
 
+  /**
+   * Replaces the item store used by the informer for the associated primary resource controller.
+   * See underlying <a href=
+   * "https://github.com/fabric8io/kubernetes-client/blob/43b67939fde91046ab7fb0c362f500c2b46eb59e/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/informers/impl/DefaultSharedIndexInformer.java#L273">
+   * method</a> in fabric8 client informer implementation.
+   *
+   * <p>
+   * The main goal, is to be able to use limited caches or provide any custom implementation.
+   * </p>
+   *
+   * <p>
+   * See {@link BoundedItemStore} and <a href=
+   * "https://github.com/operator-framework/java-operator-sdk/blob/main/caffeine-bounded-cache-support/src/main/java/io/javaoperatorsdk/operator/processing/event/source/cache/CaffeineBoundedCache.java">CaffeinBoundedCache</a>
+   * </p>
+   *
+   * @return the class of the {@link ItemStore} implementation to use
+   */
   Class<? extends ItemStore> itemStore() default ItemStore.class;
 }