Skip to content

Commit c9ced8a

Browse files
committed
wip
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
1 parent 8b3a4c7 commit c9ced8a

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,8 @@ public <R extends HasMetadata> R resourcePatch(
481481
/**
482482
* Adds the default finalizer (from controller configuration) to the primary resource. This is a
483483
* convenience method that calls {@link #addFinalizer(String)} with the configured finalizer name.
484+
* Note that explicitly adding/removing finalizer is required only if "Trigger reconciliation on
485+
* all event" mode is on.
484486
*
485487
* @return updated resource from the server response
486488
* @see #addFinalizer(String)
@@ -492,7 +494,8 @@ public P addFinalizer() {
492494
/**
493495
* Adds finalizer to the resource using JSON Patch. Retries conflicts and unprocessable content
494496
* (HTTP 422). It does not try to add finalizer if there is already a finalizer or resource is
495-
* marked for deletion.
497+
* marked for deletion. Note that explicitly adding/removing finalizer is required only if
498+
* "Trigger reconciliation on all event" mode is on.
496499
*
497500
* @return updated resource from the server response
498501
*/
@@ -512,7 +515,8 @@ public P addFinalizer(String finalizerName) {
512515
/**
513516
* Removes the default finalizer (from controller configuration) from the primary resource. This
514517
* is a convenience method that calls {@link #removeFinalizer(String)} with the configured
515-
* finalizer name.
518+
* finalizer name. Note that explicitly adding/removing finalizer is required only if "Trigger
519+
* reconciliation on all event" mode is on.
516520
*
517521
* @return updated resource from the server response
518522
* @see #removeFinalizer(String)
@@ -523,7 +527,9 @@ public P removeFinalizer() {
523527

524528
/**
525529
* Removes the target finalizer from the primary resource. Uses JSON Patch and handles retries. It
526-
* does not try to remove finalizer if finalizer is not present on the resource.
530+
* does not try to remove finalizer if finalizer is not present on the resource. Note that
531+
* explicitly adding/removing finalizer is required only if "Trigger reconciliation on all event"
532+
* mode is on.
527533
*
528534
* @return updated resource from the server response
529535
*/
@@ -614,7 +620,8 @@ public <R extends HasMetadata> R conflictRetryingPatch(
614620
/**
615621
* Adds the default finalizer (from controller configuration) to the primary resource using
616622
* Server-Side Apply. This is a convenience method that calls {@link #addFinalizerWithSSA(
617-
* String)} with the configured finalizer name.
623+
* String)} with the configured finalizer name. Note that explicitly adding finalizer is required
624+
* only if "Trigger reconciliation on all event" mode is on.
618625
*
619626
* @return the patched resource from the server response
620627
* @see #addFinalizerWithSSA(String)
@@ -626,7 +633,8 @@ public P addFinalizerWithSSA() {
626633
/**
627634
* Adds finalizer using Server-Side Apply. In the background this method creates a fresh copy of
628635
* the target resource, setting only name, namespace and finalizer. Does not use optimistic
629-
* locking for the patch.
636+
* locking for the patch. Note that explicitly adding finalizer is required only if "Trigger
637+
* reconciliation on all event" mode is on.
630638
*
631639
* @param finalizerName name of the finalizer to add
632640
* @return the patched resource from the server response

0 commit comments

Comments
 (0)