Skip to content

docs: item store on @ControllerConfiguration #1942

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 20, 2023
Merged

docs: item store on @ControllerConfiguration #1942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f225dcd
docs: item store on @ControllerConfiguration
csviri Jun 14, 2023
6ee60b8
improved
csviri Jun 19, 2023
32552a1
fix: incorrect return type, formatting and wording
metacosm Jun 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions ...work-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResourceConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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();
Expand Down
18 changes: 18 additions & 0 deletions ...ore/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ControllerConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
}