[DEPR]: openedx-event-sink-clickhouse repository

[bmtcril]

Proposal Date

2024-03-07

Target Ticket Acceptance Date

2024-03-21

Earliest Open edX Named Release Without This Functionality

Redwood - 2024-04

Rationale

The openedx-event-sink-clickhouse repository was created to facilitate moving data to ClickHouse for the Aspects project. It was thought that it could become a general use tool, or pattern that others might want to emulate for near-real-time data sharing. To the best of our knowledge, these use cases haven't appeared, and as we move closer to full adoption of event bus patterns these uses are less relevant and likely confusing in their adoption.

As such, the maintainers of the repository would like to roll the existing functionality into the new platform-plugin-aspects repository, which will house all edx-platform plugin functionality for the Aspects system. The hope is that in a future version of Aspects, all of the event sink functionality can be replaced by openedx-events and an event bus consumer.

This move should clarify that the current functionality is now Aspects-specific and reduce the maintenance burden of having an additional repository. There should currently be no loss of functionality in the move, though there expected to be breaking changes in naming, file locations, and configuration.

Removal

The openedx-event-sink-clickhouse repository will be archived and moved to the openedx-unsupported organization.

Replacement

The platform_plugin_aspects repository will be a full replacement, as well as including other plugin functionality for edx-platform.

Deprecation

No response

Migration

As the only known usage is in the tutor-contrib-aspects Tutor plugin, we expect to only need to make changes there. The plugin should make all necessary updates in Tutor based environments as part of the normal tutor config save / tutor do init / tutor images build openedx --no-cache cycle. This work is already done.

Additional Info

No response

Task List

• Create an axim-engineering ticket to archive and move the repository

[bmtcril]

This was done in the above ticket