Skip to content

Commit 515589a

Browse files
csvirimetacosm
andauthored
docs: improve read-only dependent (#2234)
Signed-off-by: Attila Mészáros <[email protected]> Signed-off-by: Chris Laprun <[email protected]> Co-authored-by: Chris Laprun <[email protected]>
1 parent 4f70aa9 commit 515589a

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/documentation/dependent-resources.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,13 @@ server. To bypass the matching feature completely, simply override the `match` m
370370
return `false`, thus telling JOSDK that the actual state never matches the desired one, making
371371
it always update the resources using SSA.
372372

373-
WARNING: Older versions of Kubernetes before 1.25 would create an additional resource version for every SSA update performed with certain resources - even though there were no actual changes in the stored resource - leading to infinite reconciliations. This behavior was seen with Secrets using `stringData`, Ingresses using empty string fields, and StatefulSets using volume claim templates. The operator framework has added built-in handling for the StatefulSet issue. If you encounter this issue on an older Kubernetes version, consider changing your desired state, turning off SSA for that resource, or even upgrading your Kubernetes version. If you encounter it on a newer Kubernetes version, please log an issue with the JOSDK and with upstream Kubernetes.
373+
WARNING: Older versions of Kubernetes before 1.25 would create an additional resource version for every SSA update
374+
performed with certain resources - even though there were no actual changes in the stored resource - leading to infinite
375+
reconciliations. This behavior was seen with Secrets using `stringData`, Ingresses using empty string fields, and
376+
StatefulSets using volume claim templates. The operator framework has added built-in handling for the StatefulSet issue.
377+
If you encounter this issue on an older Kubernetes version, consider changing your desired state, turning off SSA for
378+
that resource, or even upgrading your Kubernetes version. If you encounter it on a newer Kubernetes version, please log
379+
an issue with the JOSDK and with upstream Kubernetes.
374380

375381
## Telling JOSDK how to find which secondary resources are associated with a given primary resource
376382

@@ -544,5 +550,7 @@ several benefits:
544550
- if dependents are already used in a controller, it makes sense to unify the handling of all
545551
secondary resources as dependents from a code organization perspective
546552
- dependent resources can also interact with the workflow feature, thus allowing the read-only
547-
resource to participate in conditions, in particular to decide whether or not the primary
548-
resource needs/can be reconciled using reconcile pre-conditions
553+
resource to participate in conditions, in particular to decide whether the primary
554+
resource needs/can be reconciled using reconcile pre-conditions, block the progression of the workflow altogether with
555+
ready post-conditions or have other dependents depend on them, in essence, read-only dependents can participate in
556+
workflows just as any other dependents.

0 commit comments

Comments
 (0)