KAFKA-19379: Basic upgrade guide for KIP-1071 EA #20029
Conversation
There was a problem hiding this comment.
Pull Request Overview
Provides guidance for the Early Access release of the KIP-1071 Streams Rebalance Protocol, including its features, limitations, usage, and related interface changes.
- Introduces an “Early Access of the Streams Rebalance Protocol” section in the upgrade guide
- Documents how to enable/disable the new protocol and migration constraints
- Adds
group.protocolconfiguration reference in the developer guide
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/streams/upgrade-guide.html | Added Early Access section describing KIP-1071 features, unsupported functionality, enablement steps, and feedback channels |
| docs/streams/developer-guide/config-streams.html | Added documentation for the new group.protocol Streams config option |
Comments suppressed due to low confidence (1)
docs/streams/developer-guide/config-streams.html:784
- The word “used” appears twice; consider rephrasing to “The group protocol the Kafka Streams client uses for coordination.”
The group protocol used by the Kafka Streams client used for coordination.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
|
@lucasbru -- did you push all changes? Some replies say "Done", but I did not see any updates. |
| The group protocol used by the Kafka Streams client used for coordination. | ||
| It determines how the client will communicate with the Kafka brokers and other clients in the same group. | ||
| The default value is <code class="docutils literal"><span class="pre">"classic"</span></code>, which is the classic consumer group protocol. | ||
| Can be set to <code class="docutils literal"><span class="pre">"streams"</span></code> (requires broker side enablement) to enable the new Kafka Streams group protocol. |
There was a problem hiding this comment.
nit: "broker-side" please
| The group protocol used by the Kafka Streams client used for coordination. | ||
| It determines how the client will communicate with the Kafka brokers and other clients in the same group. | ||
| The default value is <code class="docutils literal"><span class="pre">"classic"</span></code>, which is the classic consumer group protocol. | ||
| Can be set to <code class="docutils literal"><span class="pre">"streams"</span></code> (requires broker side enablement) to enable the new Kafka Streams group protocol. |
| </p> | ||
|
|
||
| <p> | ||
| To operate the new streams groups, explore the options of <code>kafka-streams-groups.sh</code> to list, |
There was a problem hiding this comment.
This is a very good call-out. Wondering if we should update docs (follow up PR for ConsumerConfigs / StreamsConfigs) of these configs on the consumer (if it did not already happen, as 848 is already GA), and/or streams, saying something like (not applicable / ignored if "consumer" / "streams" group.protocol is used) ?
For KS, also ok to only do this with GA in AK 4.2 (but we might want to file a ticket for it).
Thoughts?
There was a problem hiding this comment.
Yeah, I was thinking about it, but I didn't want to pollute the existing docs too much with an early access feature. I think all people who try the new protocol will read this section, so we don't have to repeat it in the other documentation.
For GA, I agree, we definitely should state for every of the existing options whether they apply to KIP-1071 or not, and also describe the CLI tool in more detail.
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Basic documentation describing: - That it's in EA now
- What it does
- What features are not yet supported
- How to enable it / disable it
- Any changes in the interfaces
- kafka-streams-groups.sh
- StreamsGroupDescribe
- How to provide feedback
Reviewers: Andrew Schofield <aschofield@confluent.io>, Matthias J. Sax
<matthias@confluent.io>
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Basic documentation describing: - That it's in EA now
- What it does
- What features are not yet supported
- How to enable it / disable it
- Any changes in the interfaces
- kafka-streams-groups.sh
- StreamsGroupDescribe
- How to provide feedback
Reviewers: Andrew Schofield <aschofield@confluent.io>, Matthias J. Sax
<matthias@confluent.io>
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Basic documentation describing: - That it's in EA now
- What it does
- What features are not yet supported
- How to enable it / disable it
- Any changes in the interfaces
- kafka-streams-groups.sh
- StreamsGroupDescribe
- How to provide feedback
Reviewers: Andrew Schofield <aschofield@confluent.io>, Matthias J. Sax
<matthias@confluent.io>
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Basic documentation describing: - That it's in EA now
What it does
What features are not yet supported
How to enable it / disable it
Any changes in the interfaces
How to provide feedback
Reviewers: Andrew Schofield aschofield@confluent.io, Matthias J. Sax
matthias@confluent.io