From 5543324f4c3c28448dca01df5ba3a47c09d5aecd Mon Sep 17 00:00:00 2001 From: George Sun Date: Fri, 27 Dec 2024 15:02:01 +0800 Subject: [PATCH] Document the internal topic logic for topic enforcer. --- kafka_topic_enforcer/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/kafka_topic_enforcer/README.md b/kafka_topic_enforcer/README.md index 4769efc..ff668eb 100644 --- a/kafka_topic_enforcer/README.md +++ b/kafka_topic_enforcer/README.md @@ -8,6 +8,8 @@ Kafka topic enforcer's goal is to automate Kafka topic management & hence remove * Applies uniform central control to topics and enforces best practices consistently (aka idiot proofing) * Self service, removed dependency on a human * Simple configuration +* Internal Kafka topics (with a suffix of underscore `_`) are skipped from enforcement. Good for tools like kminion that + needs to manage the topics on its own. If you choose to use Strimzi Kafka operator, this command can also generate Strimzi KafkaTopic CRDs.