KIP 848 updates + faq cleanup #182
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates Karafka documentation to reflect KIP-848 (the new consumer protocol available in Kafka 4.0+) and removes outdated FAQ entries that are no longer relevant.
- Adds KIP-848 consumer protocol configuration examples throughout documentation
- Updates rebalancing strategy recommendations to prioritize KIP-848 for Kafka 4.0+ deployments
- Removes obsolete FAQ entries about older versions, deprecated features, and outdated troubleshooting
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Pro/Multiplexing.md | Updates dynamic multiplexing to recommend KIP-848 for Kafka 4.0+ with fallback to cooperative-sticky |
| Pro/Long-Running-Jobs.md | Updates rebalancing strategy recommendations with KIP-848 examples for long-running jobs |
| FAQ.md | Removes outdated FAQ entries and adds KIP-848 recommendations throughout various sections |
| Development-vs-Production.md | Adds comprehensive KIP-848 configuration examples for production deployments |
| Deployment.md | Updates Kubernetes deployment section with KIP-848 strategy recommendations |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| ## Why there used to be an ApplicationController mentioned in the Wiki and some articles? | ||
|
|
||
| You can name the main application consumer with any name. You can even call it ```ApplicationController``` or anything else you want. Karafka will sort that out, as long as your root application consumer inherits from the ```Karafka::BaseConsumer```. It's not related to Ruby on Rails controllers. Karafka framework used to use the ```*Controller``` naming convention up until Karafka 1.2 where it was changed because many people had problems with name collisions. | ||
| **No**. Karafka is a fully independent framework that can operate in a standalone mode. It can be easily integrated with any Ruby-based application, including those written with Ruby on Rails. Please follow the [Integrating with Ruby on Rails and other frameworks](Integrating-with-Ruby-on-Rails-and-other-frameworks) documentation. |
There was a problem hiding this comment.
The link reference (Integrating-with-Ruby-on-Rails-and-other-frameworks) appears to be a relative reference but may not resolve correctly. Consider using a full URL or verifying that this internal link target exists.
Suggested change
| **No**. Karafka is a fully independent framework that can operate in a standalone mode. It can be easily integrated with any Ruby-based application, including those written with Ruby on Rails. Please follow the [Integrating with Ruby on Rails and other frameworks](Integrating-with-Ruby-on-Rails-and-other-frameworks) documentation. | |
| **No**. Karafka is a fully independent framework that can operate in a standalone mode. It can be easily integrated with any Ruby-based application, including those written with Ruby on Rails. Please follow the [Integrating with Ruby on Rails and other frameworks](./Integrating-with-Ruby-on-Rails-and-other-frameworks.md) documentation. |
Copilot uses AI. Check for mistakes.
| ## Does Karafka require a separate process running? | ||
|
|
||
| No, however, it is **recommended**. By default, Karafka requires a separate process (Karafka server) to consume and process messages. You can read about it in the [Consuming messages](https://github.com/karafka/karafka/wiki/Consuming-Messages) section of the Wiki. | ||
| No, however, it is **recommended**. By default, Karafka requires a separate process (Karafka server) to consume and process messages. You can read about it in the [Consuming messages](Consuming-Messages) section of the documentation. |
There was a problem hiding this comment.
The link reference (Consuming-Messages) appears to be a relative reference but may not resolve correctly. Consider using a full URL or verifying that this internal link target exists.
Suggested change
| No, however, it is **recommended**. By default, Karafka requires a separate process (Karafka server) to consume and process messages. You can read about it in the [Consuming messages](Consuming-Messages) section of the documentation. | |
| No, however, it is **recommended**. By default, Karafka requires a separate process (Karafka server) to consume and process messages. You can read about it in the [Consuming messages](#consuming-messages) section of the documentation. |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this PR updates docs to reflect the KIP 848 + removes older no longer valid entries from the FAQ.