Skip to content

Commit 82877ee

Browse files
csviriCopilot
andauthored
docs: eventing hides implementation details (#3379)
Signed-off-by: Attila Mészáros <a_meszaros@apple.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent f50b74a commit 82877ee

1 file changed

Lines changed: 11 additions & 14 deletions

File tree

docs/content/en/docs/documentation/eventing.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,21 +42,18 @@ graph LR
4242
classDef controller fill:#326CE5,stroke:#1A4AAF,color:#fff
4343
classDef secondary fill:#3AAFA9,stroke:#2B807B,color:#fff
4444
```
45-
4645
A few things worth highlighting about the diagram above.
47-
- The `ControllerEventSource` is a special, internal event source responsible for handling events
48-
pertaining to changes affecting the primary resource. The SDK registers it automatically for every
49-
controller and you never instantiate it yourself.
50-
- Every controller also gets a dedicated `TimerEventSource` (named
51-
`RetryAndRescheduleTimerEventSource`) that the SDK uses to drive retry attempts after a failed
52-
reconciliation, `UpdateControl.rescheduleAfter(...)` requests, and the periodic max-interval
53-
failsafe trigger. The `EventProcessor` is the sole caller into this timer, scheduling delayed
54-
events back to itself via `scheduleOnce(...)`. Like the controller event source, this one is
55-
wired internally and is not something you register or interact with directly.
56-
- Once an event reaches the `EventProcessor`, dispatch is delegated to the
57-
`ReconciliationDispatcher`, which prepares the execution context, handles finalizers and other
58-
framework concerns, and ultimately invokes `reconcile(...)` on the internal `Controller` wrapper,
59-
which in turn calls the user-implemented `Reconciler`.
46+
47+
- The framework includes an internal event source (`ControllerEventSource`) for changes affecting
48+
the primary resource. The SDK registers it automatically for every controller, and you never
49+
instantiate it yourself.
50+
- Every controller also gets an internal timer-based event source that the SDK uses for delayed
51+
retries, `UpdateControl.rescheduleAfter(...)` requests, and periodic failsafe triggering. Like
52+
the controller event source, it is wired internally and is not something you register or interact
53+
with directly.
54+
- Once an event enters the framework's processing pipeline, the SDK prepares the reconciliation
55+
context, handles finalizers and other framework concerns, and then invokes the user-implemented
56+
`Reconciler`.
6057

6158
Events always relate to a given primary resource, and the SDK guarantees that there is no
6259
concurrent execution of the reconciler for any given primary resource, even in the presence of

0 commit comments

Comments
 (0)