Skip to content

Commit cfac3fc

Browse files
committed
clarify docs, clean up
1 parent 53121de commit cfac3fc

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/modules/kafka/pages/usage-guide/kraft-controller.adoc

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
= KRaft
1+
= KRaft mode
22
:description: Apache Kafka KRaft mode with the Stackable Operator for Apache Kafka
33

4-
Apache Kafka's KRaft mode (Kafka Raft Metadata mode) replaces Apache ZooKeeper with Kafka’s own built-in consensus mechanism based on the Raft protocol.
4+
Apache Kafka's KRaft mode replaces Apache ZooKeeper with Kafka’s own built-in consensus mechanism based on the Raft protocol.
55
This simplifies Kafka’s architecture, reducing operational complexity by consolidating cluster metadata management into Kafka itself.
66

77
WARNING: The Stackable Operator for Apache Kafka currently does not support automatic cluster upgrades from Apache ZooKeeper to KRaft.
@@ -38,7 +38,7 @@ spec:
3838
replicas: 3
3939
----
4040

41-
NOTE: This is mutally exclusive with `spec.clusterConfig.zookeeperConfigMapName`.
41+
NOTE: Using `spec.controllers` is mutally exclusive with `spec.clusterConfig.zookeeperConfigMapName`.
4242

4343
=== Recommendations
4444

@@ -70,19 +70,17 @@ controllers:
7070
capacity: 2Gi
7171
----
7272

73-
=== Affinities
74-
75-
=== PDBs
76-
7773
=== Overrides
7874

75+
The configuration of overrides, JVM arguments etc. is similar to the Broker and documented on the xref:concepts:overrides.adoc[concepts page].
76+
7977
== Internal operator details
8078

8179
KRaft mode requires major configuration changes compared to ZooKeeper:
8280

8381
* `cluster-id`: This is set to the `metadata.uid` of the KafkaCluster resource during initial formatting
84-
* `node.id`: This is a calculated integer, hashed from the `role` and `rolegroup` and `replica` id.
85-
* `process.roles`: Will always only be `broker` or `controller`. Mixed `broker,controller` servers are not possible.
82+
* `node.id`: This is a calculated integer, hashed from the `role` and `rolegroup` and added `replica` id.
83+
* `process.roles`: Will always only be `broker` or `controller`. Mixed `broker,controller` servers are not supported.
8684

8785
== Troubleshooting
8886

@@ -96,7 +94,8 @@ Likely caused by controller resource starvation or unstable Kubernetes schedulin
9694

9795
=== Migration issues (ZooKeeper to KRaft)
9896

99-
Ensure Kafka version 3.9.x and higher and follow the official migration documentation.
97+
Ensure Kafka version 3.9.x and higher and follow the official migration documentation.
98+
The Stackable Kafka operator currently does not support the migration.
10099

101100
=== Scaling issues
102101

docs/modules/kafka/pages/usage-guide/overrides.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ IMPORTANT: Overriding operator-set properties (such as the ports) can interfere
88

99
For a role or role group, at the same level of `config`, you can specify: `configOverrides` for the following files:
1010

11-
* `broker.properties`
11+
* `broker.properties` (brokers only)
12+
* `controller.properties` (KRaft controllers only)
1213
* `security.properties`
1314

1415
For example, if you want to set the `auto.create.topics.enable` to disable automatic topic creation, it can be configured in the KafkaCluster resource like so:

0 commit comments

Comments
 (0)