Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC-0008] Custom Event Metadata from Annotations #4809

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

matheuscscp
Copy link
Member

@matheuscscp matheuscscp commented May 23, 2024

This RFC comes as a response to the need for adding custom metadata to events about Flux objects
sent to notification providers.

When a Flux controller sends events about Flux objects, we propose sending annotation keys prefixed with the well-defined API Group event.toolkit.fluxcd.io followed by a slash, i.e. prefixed with event.toolkit.fluxcd.io/, in addition to all the metadata that is already sent by the controller.

@moritzschmitz-oviva
Copy link

This is great! Thanks again for picking this up, @matheuscscp 🎉 !

I have nothing to add. It explains the use case very well.

Regarding the API group, I don't know enough about the benefits of implementing the EventRecorder interface. Otherwise, your first suggestion looks sufficient.

@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch 2 times, most recently from 6d5ee27 to 14079bc Compare June 10, 2024 11:36
@stefanprodan stefanprodan changed the title Add RFC 0007 - Custom Event Metadata from Annotations [RFC] Custom Event Metadata from Annotations Jun 13, 2024
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch from a2c7092 to f9571f8 Compare June 23, 2024 08:10
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch 4 times, most recently from 7b62750 to 0928016 Compare July 4, 2024 15:44
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch 2 times, most recently from 51936fa to ad059ae Compare July 4, 2024 15:48
Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks @matheuscscp 🏅

@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch from ad059ae to e338913 Compare August 12, 2024 01:29
@benoittgt
Copy link

I would love to see this RFC merged. Is there anything I can do ?

Also for the implementation. Who's gonna make it ? I am interested to help with my low-level Go skills. :)

Thanks

@matheuscscp
Copy link
Member Author

I would love to see this RFC merged. Is there anything I can do ?

Also for the implementation. Who's gonna make it ? I am interested to help with my low-level Go skills. :)

Thanks

Hi @benoittgt!

Thanks for reaching out! I'm working on this RFC. I'm on vacations this week, but I will pick up the pace next week :)

Stay tuned!

@kingdonb kingdonb removed their request for review November 29, 2024 17:55
@stefanprodan stefanprodan added the area/rfc Feature request proposals in the RFC format label Dec 17, 2024
Copy link
Member

@makkes makkes left a comment

Choose a reason for hiding this comment

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

I like this improvement!

rfcs/xxxx-custom-event-metadata-from-annotations/README.md Outdated Show resolved Hide resolved
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch from 052da50 to 1768ecf Compare December 17, 2024 13:58
@stefanprodan stefanprodan changed the title [RFC] Custom Event Metadata from Annotations [RFC-0008] Custom Event Metadata from Annotations Dec 17, 2024
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch 2 times, most recently from 4763c5b to a71d0b7 Compare December 19, 2024 15:15
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch 2 times, most recently from c546fa7 to 73d23f1 Compare December 20, 2024 15:03
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch from 73d23f1 to b81f480 Compare December 23, 2024 16:23
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch 4 times, most recently from cd45381 to 820476b Compare December 24, 2024 15:13
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch 2 times, most recently from 684d677 to 8492711 Compare December 25, 2024 13:56
@matheuscscp matheuscscp force-pushed the rfc-7-custom-event-metadata branch from 8492711 to 83c16f9 Compare January 7, 2025 10:44
@matheuscscp matheuscscp merged commit 16f55bb into fluxcd:main Jan 7, 2025
5 checks passed
@matheuscscp matheuscscp deleted the rfc-7-custom-event-metadata branch January 7, 2025 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/rfc Feature request proposals in the RFC format
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants