Skip to content

✨ Add AnnotatedEventRecorderProvider interface#3509

Draft
adri1197 wants to merge 1 commit intokubernetes-sigs:mainfrom
adri1197:annotations-event-recorder
Draft

✨ Add AnnotatedEventRecorderProvider interface#3509
adri1197 wants to merge 1 commit intokubernetes-sigs:mainfrom
adri1197:annotations-event-recorder

Conversation

@adri1197
Copy link
Copy Markdown

Adds support for creating event recorders that can attach custom annotations to events,
mirroring the AnnotatedEventf capability recently added to client-go/tools/events
(see kubernetes/kubernetes#138103).

This introduces a new AnnotatedEventRecorderProvider interface in pkg/recorder rather
than adding a method to the existing Provider interface, so this is a backwards-compatible
change. Consumers can type-assert the manager/cluster to access the new functionality:

if p, ok := mgr.(recorder.AnnotatedEventRecorderProvider); ok {
    rec := p.GetAnnotatedEventRecorder("my-controller")
    rec.AnnotatedEventf(obj, nil, map[string]string{"key": "value"}, corev1.EventTypeNormal, "Reason", "Action", "Note")
}

Changes:

  • Added AnnotatedEventRecorderProvider interface in pkg/recorder
  • Implemented GetAnnotatedEventRecorder on the internal recorder Provider
  • Implemented AnnotatedEventf on lazyRecorder
  • Added GetAnnotatedEventRecorder on cluster and controllerManager (concrete types only, no interface changes)
  • Added unit and integration tests

Add the missing AnnotatedEventf as
a new interface AnnotatedEventRecorder
under cluster, manager, and recorder provider
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 27, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: adri1197
Once this PR has been reviewed and has the lgtm label, please assign sbueringer for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @adri1197!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-runtime has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 27, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @adri1197. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants