flag

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Author: csviri

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

@@ -464,6 +464,24 @@ default boolean parseResourceVersionsForEventFilteringAndCaching() {
     return false;
   }
 
+  /**
+   * If you update the primary resource from the reconciler with or without {@link
+   * io.javaoperatorsdk.operator.api.reconciler.UpdateControl} it is not guaranteed that for the
+   * next reconciliation will receive the most up-to-date resource. This is a consequence of
+   * Informers design in the Operator pattern.
+   *
+   * <p>The framework can be smart about it and make such guarantees, but this can be done
+   * absolutely reliably only if it bends some rules of the Kubernetes API contract. Thus, if we
+   * parse the resourceVersion of a primary resource as an integer and compare it with the version
+   * of the resource in the cache. Note that this is a gray area, since with default setup Etcd
+   * guarantees such monotonically increasing resource versions. But since it is still bending the
+   * rules by default, this feature is turned off, and work only if {@link
+   * #parseResourceVersionsForEventFilteringAndCaching} is also set to true.
+   *
+   * <p>See also {@link io.javaoperatorsdk.operator.api.reconciler.PrimaryUpdateAndCacheUtils}
+   *
+   * @return if the framework should cache the updated resource for next reconciliation
+   */
   default boolean cacheUpdatedResourcesViaUpdateControl() {
     return false;
   }