Feature Overview (aka. Goal Summary)

This spike investigated setting up Events for Github Discovery in RHDH using an HTTP endpoint. We should look into adding the event modules listed in the requirements section to RHDH.

For 1.8 target Tech Preview as additional investigation is needed to push to GA.

Investigation Doc: https://docs.google.com/document/d/1ZOQ3QUvATEVmMVxbQVpnM9cTF85AK4k6IjbdBIKs7RY/edit?tab=t.0#heading=h.319wh5le5fvn 

Demo:  https://drive.google.com/file/d/1K7h8EWrFMQkynpEbkEwY2smawXhiJUuC/view?usp=sharing 

List of Supported Plugins: https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/main/modules/dynamic-plugins/rhdh-supported-plugins.csv 

Goals (aka. expected user outcomes)

By configuring a webhook for the external service the customer uses to ingest entities, users can enable real-time catalog updates triggered by events.

Requirements (aka. Acceptance Criteria):

• Add the selected event modules to RHDH as wrappers (If we're still using wrappers in 1.8)
• Package these plugins as an OCI images using the overlay repository into dynamic plugins.
• E2E tests
• Documentation

List of event modules that can potentially be included:

• @backstage/plugin-events-backend-module-github (to enable event based ingestion for GitHub Discovery,  Github Org Data
• @backstage/plugin-events-backend-module-bitbucket-cloud (to enable event based ingestion for Bitbucket Cloud Discovery)
• @backstage/plugin-events-backend-module-bitbucket-server ( to enable event based ingestion for Bitbucket Server Discovery)
• @backstage/plugin-events-backend-module-gitlab (to enable event based ingestion for Gitlab Discovery, Gitlab Org Data)

Documentation Considerations

• Document how to setup these event modules in RHDH. I wrote down the steps I had to follow to enable the `@backstage/plugin-events-backend-module-github`in RHDH here.
• Document when to use these modules and also highlight limitations.