-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update event bus architecture doc to include event_bus_redis
Also update its status to `Accepted`.
- Loading branch information
1 parent
4c9780e
commit 0e31b6c
Showing
1 changed file
with
14 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,13 +11,13 @@ OEP-52: Event Bus Architecture | |
* - Title | ||
- Event Bus Architecture | ||
* - Last Modified | ||
- 2022-07-11 | ||
- 2023-05-12 | ||
* - Authors | ||
- Feanil Patel <[email protected]>, Robert Raposa <[email protected]> | ||
* - Arbiter | ||
- Tobias Macey <[email protected]> | ||
* - Status | ||
- Provisional | ||
- Accepted | ||
* - Type | ||
- Architecture | ||
* - Created | ||
|
@@ -77,6 +77,10 @@ Decision | |
* See edx.org `ADR on Kafka Managed Hosting`_ if considering Kafka hosting options. | ||
* See edx.org `ADR on Managing Kafka Consumers`_ if exploring how to deploy consumers for Kafka. | ||
|
||
* A secondary implementation is being implemented using Redis streams. | ||
|
||
* see edx.org `ADR on Redis streams Event Bus`_. | ||
|
||
* Event bus events will further extend the Hooks Extension Framework events, and use an Avro schema to serialize the existing hooks signals. | ||
|
||
* See `ADR on External event bus and Django Signal events`_ to learn more about how the ``OpenEdxPublicSignal`` internal event will be used to send the same internal signal-based events across services, and then fire the signal-based events again within consuming services. | ||
|
@@ -86,6 +90,8 @@ Decision | |
.. _ADR on Kafka Managed Hosting: https://github.com/openedx/event-bus-kafka/blob/main/docs/decisions/0004-kafka-managed-hosting.rst | ||
.. _ADR on Managing Kafka Consumers: https://github.com/openedx/event-bus-kafka/blob/main/docs/decisions/0003-managing-kafka-consumers.rst | ||
|
||
.. _ADR on Redis streams Event Bus: https://github.com/openedx/event-bus-redis/blob/main/docs/decisions/0002-redis-streams-based-event-bus.rst | ||
|
||
.. _ADR on External event bus and Django Signal events: https://openedx-events.readthedocs.io/en/latest/decisions/0004-external-event-bus-and-django-signal-events.html | ||
.. _ADR on External Event Schema Format: https://openedx-events.readthedocs.io/en/latest/decisions/0005-external-event-schema-format.html | ||
.. _ADR on Event Schema Serialization and Evolution: https://openedx-events.readthedocs.io/en/latest/decisions/0006-event-schema-serialization-and-evolution.html | ||
|
@@ -102,6 +108,12 @@ Consequences | |
Change History | ||
************** | ||
|
||
2023-05-12 | ||
========== | ||
|
||
* Added link to event_bus_redis implementation ADR. | ||
* Updated status | ||
|
||
2022-11-29 | ||
========== | ||
|
||
|