Skip to content

docs(kafka): clarify Kafka topic retention requirements #15149

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −8
Open

docs(kafka): clarify Kafka topic retention requirements #15149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/deploy/confluent-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ First, you'll need to create following new topics in the [Confluent Control Cent
6. (Deprecated) **MetadataChangeEvent_v4**: Metadata change proposal messages
7. (Deprecated) **MetadataAuditEvent_v4**: Metadata change log messages
8. (Deprecated) **FailedMetadataChangeEvent_v4**: Failed to process #1 event
9. **MetadataGraphEvent_v4**:
10. **PlatformEvent_v1**
9. (Deprecated) **MetadataGraphEvent_v4**: Legacy topic deprecated since 2021, no longer actively used
10. **PlatformEvent_v1**: High-level semantic events
11. **DataHubUpgradeHistory_v1**: Notifies the end of DataHub Upgrade job so dependants can act accordingly (_eg_, startup).
Note this topic requires special configuration: **Infinite retention**. Also, 1 partition is enough for the occasional traffic.
Note this topic requires special configuration: **Recommended: 7-30 day retention** (default config shows infinite retention for safety, but not required if `DATAHUB_SYSTEM_UPDATE_WAIT_FOR_SYSTEM_UPDATE=false`). Also, 1 partition is enough for the occasional traffic.

The first five are the most important, and are explained in more depth in [MCP/MCL](../advanced/mcp-mcl.md). The final topics are
those which are deprecated but still used under certain circumstances. It is likely that in the future they will be completely
Expand Down
9 changes: 4 additions & 5 deletions docs/how/kafka-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,10 @@ By default, DataHub relies on the a set of Kafka topics to operate. By default,
6. (Deprecated) **MetadataChangeEvent_v4**: Metadata change proposal messages
7. (Deprecated) **MetadataAuditEvent_v4**: Metadata change log messages
8. (Deprecated) **FailedMetadataChangeEvent_v4**: Failed to process #1 event
9. **MetadataGraphEvent_v4**:
10. **MetadataGraphEvent_v4**:
11. **PlatformEvent_v1**:
12. **DataHubUpgradeHistory_v1**: Notifies the end of DataHub Upgrade job so dependants can act accordingly (_eg_, startup).
Note this topic requires special configuration: **Infinite retention**. Also, 1 partition is enough for the occasional traffic.
9. (Deprecated) **MetadataGraphEvent_v4**: Legacy topic deprecated since 2021, no longer actively used
10. **PlatformEvent_v1**: High-level semantic events
11. **DataHubUpgradeHistory_v1**: Notifies the end of DataHub Upgrade job so dependants can act accordingly (_eg_, startup).
Note this topic requires special configuration: **Recommended: 7-30 day retention** (default config shows infinite retention for safety, but not required if `DATAHUB_SYSTEM_UPDATE_WAIT_FOR_SYSTEM_UPDATE=false`). Also, 1 partition is enough for the occasional traffic.

How Metadata Events relate to these topics is discussed at more length in [Metadata Events](../what/mxe.md).

Expand Down
Loading