community
community copied to clipboard
goharbor
CDEvents proposal
Proposal to implement CDEvents (cdevents.dev) notifications for Harbor.
This proposal is not 100% complete yet, the "Implementation Design" section is TBD, and there are a few open questions.
Due to the current limitation of CDEvents, only the "artifact.published" event is supported at the moment. Therefore, I would like to hold on this proposal for now.
In order to introduce a new format of webhook, Harbor requires that there are no disruptive changes to user behavior, both from the UI and API perspectives, and that consistency is maintained.
The dependency here is that either CDEvents should support all types of events defined on the Harbor side or provide a general method for Harbor to define customized events, whether through annotations or attributes.
It needs to discuss
Thanks @wy65701436 - I'm happy to discuss about this - what is your preferred forum for discussion? Would that be the Harbor working group or here on the proposal or else?
@afrittoli what's the progress of this one do you need anything from our side?
@afrittoli what's the progress of this one do you need anything from our side?
Hi @OrlinVasilev, thanks for asking. I've been working with the CDEvents community to add:
- more artifact events https://github.com/cdevents/spec/pull/172 - Done
- support for custom events https://hackmd.io/LftfRirGRbKuAcLg9pdOag - In progress
The two features will allow covering all existing Harbor events through CDEvents, as requested.
Feel free to review the custom events proposal https://hackmd.io/LftfRirGRbKuAcLg9pdOag - I used Harbor as a case study for that.
@afrittoli what's the progress of this one do you need anything from our side?
Hi @OrlinVasilev, thanks for asking. I've been working with the CDEvents community to add:
- more artifact events Add user field to artifact events and download and delete events cdevents/spec#172 - Done
- support for custom events https://hackmd.io/LftfRirGRbKuAcLg9pdOag - In progress
The two features will allow covering all existing Harbor events through CDEvents, as requested.
Feel free to review the custom events proposal https://hackmd.io/LftfRirGRbKuAcLg9pdOag - I used Harbor as a case study for that.
An update on this. Support for custom events was just merged in CDEvents https://github.com/cdevents/spec/tree/main/custom. We'll probably cut a release after KubeCon and then I will be able to update the proposal and implementation with support for all existing Harbor events as requested.
The registry: maintainers of the specifications of CDEvents custom events are encouraged to add their specification to the shared registry
@wy65701436 @chlins @OrlinVasilev can we agree upon supporting or not supporting this feature and let @afrittoli know before more time is wasted?
Since Harbor already supports clouddevents, it may already meet the needs of most cloud-native users. For cdevents, it is more likely to be focused on the area of continuous deployment, and the Harbor community hasn't received too many requests for cdevents support yet, so I'm not sure if this is really valuable or or applicable scenarios to harbor users , so I think we can hold it for a while and wait for more user feedback, and at the same time we can monitor whether there are other artifact registries supports the cdevents.
