From 965ca841f2192e43b9a2e092dd4d4121828f569e Mon Sep 17 00:00:00 2001
From: Nir Gazit <nir.gzt@gmail.com>
Date: Tue, 26 Jan 2021 09:22:04 +0200
Subject: [PATCH] Updated changeset with breaking changes documentation

---
 .changeset/fast-flowers-tickle.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/.changeset/fast-flowers-tickle.md b/.changeset/fast-flowers-tickle.md
index 193b9b4459..48051c197b 100644
--- a/.changeset/fast-flowers-tickle.md
+++ b/.changeset/fast-flowers-tickle.md
@@ -4,3 +4,28 @@
 ---
 
 Added support for multiple Kafka clusters and multiple consumers per component.
+Note that this introduces several breaking changes.
+
+1. Configuration in `app-config.yaml` has changed to support the ability to configure multiple clusters. This means you are required to update the configs in the following way:
+
+```diff
+kafka:
+   clientId: backstage
+-  brokers:
+-    - localhost:9092
++  clusters:
++    - name: prod
++      brokers:
++        - localhost:9092
+```
+
+2. Configuration of services has changed as well to support multiple clusters:
+
+```diff
+  annotations:
+-    kafka.apache.org/consumer-groups: consumer
++    kafka.apache.org/consumer-groups: prod/consumer
+```
+
+3. Kafka Backend API has changed, so querying offsets of a consumer group is now done with the following query path:
+   `/consumers/${clusterId}/${consumerGroup}/offsets`