Skip to content

docs: event filter page#3467

Open
csviri wants to merge 1 commit into
operator-framework:mainfrom
csviri:filters-docs
Open

docs: event filter page#3467
csviri wants to merge 1 commit into
operator-framework:mainfrom
csviri:filters-docs

Conversation

@csviri

@csviri csviri commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

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

Copilot AI review requested due to automatic review settings July 2, 2026 16:25
@openshift-ci openshift-ci Bot requested review from metacosm and xstefank July 2, 2026 16:25
@csviri csviri linked an issue Jul 2, 2026 that may be closed by this pull request

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new documentation page describing Java Operator SDK event filters (types, configuration for primary/secondary resources, and default/internal filter behavior) and wires it into the documentation index so it’s discoverable under Advanced Features.

Changes:

  • Introduce a new “Event filters” documentation page covering filter interfaces, composition, and configuration patterns.
  • Document default (internal) update filters and how to disable them (defaultFilters = false).
  • Add the new page to the Documentation section’s Advanced Features list.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/content/en/docs/documentation/event-filters.md New documentation page explaining event filter types, configuration, and default/internal filter behavior.
docs/content/en/docs/documentation/_index.md Adds navigation entry for the new “Event filters” page under Advanced Features.

Comment on lines +60 to +62
// reconcile only if the value actually changed
return !newResource.getSpec().getValue().equals(SKIP_VALUE);
}
Comment on lines +82 to +83
.withOnUpdateFilter(
(newCM, oldCM) -> !newCM.getData().get(VALUE_KEY).equals(SKIP_VALUE))
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
your operator efficient by avoiding needless reconciliations.

Filters apply both to the **primary resource** (the resource your `Reconciler` manages) and to any
**secondary resources** watched through an [`InformerEventSource`](eventing.md#informereventsource).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's worth pointing that for non-Kubernetes resources, there's no need for filtering because it should be the responsibility of the EventSource to only emit relevant events?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add event filtering page into documentation

4 participants