Skip to content

Commit 1dc8669

Browse files
authored
docs: improve wording (#2844)
[skip ci] Signed-off-by: Chris Laprun <[email protected]>
1 parent 8db818c commit 1dc8669

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

docs/content/en/docs/faq/_index.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,30 +97,31 @@ Dependent Resources feature supports the [first approach](../documentation/depen
9797

9898
### How can I make the status update of my custom resource trigger a reconciliation?
9999

100-
For the primary resource, the framework by default specially checks if the change on the primary
101-
resource is increased the `generation` field in the metadata, and filters out the related event if not.
102-
This field is increased when `.spec` of the resource is changed. Therefore, a change in the `.status` field
103-
will not trigger a reconciliation.
100+
The framework checks, by default, when an event occurs, that could trigger a reconciliation, if the event increased the
101+
`generation` field of the primary resource's metadata and filters out the event if it did not. `generation` is typically
102+
only increased when the `.spec` field of a resource is changed. As a result, a change in the `.status` field would not
103+
normally trigger a reconciliation.
104104

105-
To change this behavior, you can set the [`generationAwareEventProcessing`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ControllerConfiguration.java#L43)
105+
To change this behavior, you can set the [
106+
`generationAwareEventProcessing`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ControllerConfiguration.java#L43)
106107
to `false`:
107108

108109
```java
110+
109111
@ControllerConfiguration(generationAwareEventProcessing = false)
110-
static class TestCustomReconciler implements Reconciler<TestCustomResource> {
112+
static class TestCustomReconciler implements Reconciler<TestCustomResource> {
111113

112114
@Override
113115
public UpdateControl<TestCustomResource> reconcile(TestCustomResource resource, Context<TestCustomResource> context) {
114116
// code omitted
115117
}
116-
}
118+
}
117119
```
118120

119-
For secondary resources, every change should trigger a reconciliation by default.
120-
Except when you add explicit filter or use dependent resources that by default filter out own changes,
121+
For secondary resources, every change should trigger a reconciliation by default, except when you add explicit filters
122+
or use dependent resource implementations that filter out changes they trigger themselves by default,
121123
see [related docs](../documentation/dependent-resource-and-workflows/dependent-resources.md#caching-and-event-handling-in-kubernetesdependentresource).
122124

123-
124125
### How can I skip the reconciliation of a dependent resource?
125126

126127
Skipping workflow reconciliation altogether is possible with the explicit invocation feature since v5.

0 commit comments

Comments
 (0)