Skip to content

Commit 12b6913

Browse files
Apply suggestions from code review
Co-authored-by: Natalie Klestrup Röijezon <nat.roijezon@stackable.tech>
1 parent 1411d55 commit 12b6913

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

modules/ROOT/pages/release-notes.adoc

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -245,14 +245,33 @@ Of the changes mentioned above, the following are breaking (or could lead to bre
245245
246246
==== Kafka operator
247247
248-
* Existing services will be migrated to the new format. Clients will need to re-read settings from the discovery configmap.
249-
* Kafka is now only accessible from within the Kubernetes cluster by default. Set listener classes manually to expose it to the outside world (again).
250-
* To complete an upgrade to this kafka-operator, all existing Kafka StatefulSets must be deleted manually. This will cause some downtime.
248+
* Existing Kafka clusters will need to be migrated to using the Listener Operator.
249+
Kafka clients will need to re-read settings from the discovery configmap (restart required).
250+
Existing Kafka StatefulSets must be deleted manually. This will cause some downtime.
251+
* Kafka is now only accessible from within the Kubernetes cluster by default.
251252
252253
.Breaking changes details
253254
[%collapsible]
254255
====
255-
* `spec.blah`: Describe a change.
256+
Migrating Kafka clusters to use the Listener Operator is done by deleting the Kafka StatefulSet after the new Stackable Operator for Kafka has been installed, by running the following:
257+
258+
[source,console]
259+
....
260+
kubectl delete --all-namespaces StatefulSet --selector=app.kubernetes.io/managed-by=kafka.stackable.tech_kafkacluster
261+
....
262+
263+
The operator will then recreate it.
264+
Please note that the Kafka cluster will be unavailable during the procedure.
265+
266+
After the upgrade, Kafka clusters will default to only being accessible from inside the Kubernetes cluster.
267+
268+
To make the cluster accessible from the outside, set the following _before deleting the StatefulSet_:
269+
270+
* `KafkaCluster.spec.brokers.config.bootstrapListenerClass: external-stable`
271+
* `KafkaCluster.spec.brokers.config.brokerListenerClass: external-unstable`
272+
273+
Please note that this upgrade will randomize the address that users will have to connect to, so any external clients must re-read it from the discovery configuration after the upgrade has been completed.
274+
This can be done by restarting the client.
256275
====
257276
258277
==== Listener operator

0 commit comments

Comments
 (0)