MINOR: Update 3.8 documentation for Kafka Streams#16265
MINOR: Update 3.8 documentation for Kafka Streams#16265lucasbru merged 15 commits intoapache:trunkfrom
Conversation
|
@ableegoldman @nicktelford @calmera We need to update the documentation based on your KIPs. Mostly I was able to copy the docs from the KIPs, so instead of pinging everyone individually, I did it myself. Feel free to leave comments. |
nicktelford
left a comment
There was a problem hiding this comment.
LGTM, thanks @lucasbru
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
| This change also removes the internal config <code>internal.task.assignor.class</code> that was used for the same | ||
| purpose. If you were using this config, you should switch to using <code>task.assignor.class</code> instead. |
There was a problem hiding this comment.
note: we haven't removed this config yet, planning to do so after 3.8
Might still be worth mentioning it here to encourage anyone who was using it before to switch over to the new config/the new StickyTaskAssignor interface. So we can keep this wording but just change it from "We removed the internal config..." to something like "We introduced a new config to replace the internal config ..."
There was a problem hiding this comment.
update: we will be renaming the old StickyTaskAssignor class to LegacyStickyTaskAssignor (if/when this PR is merged) so perhaps we should just say something like this:
"If you were using the old internal config internal.task.assignor.class to plug in a task assignor, please migrate your code to the new public config and pass in an assignor that implements the new TaskAssignor interface"
There was a problem hiding this comment.
I'll wait with the documentation updates once the renamings have settled in the 3.8 branch
There was a problem hiding this comment.
@lucasbru alright, just merged that PR to 3.8. Here's where 3.8 stands:
- has not removed the old
internal.task.assignorconfig, though we want to encourage anyone using that to migrate to the new public config instead. should say something like "If you were using the oldinternal.task.assignor.classconfig, you should switch to using the newtask.assignor.classconfig instead" - renamed the old TaskAssignor interface (which goes with the old
internal.task.assignorconfig) to the LegacyTaskAssignor (don't need to say anything about this in the docs, just adding it for context) - renamed the old StickyTaskAssignor (which implements the LegacyTaskAssignor) to the LegacyStickyTaskAssignor, so "StickyTaskAssignor" now refers to (only) the new version of this assignor which implements the new TaskAssignor interface. For the docs, we should mention something like "If you were previously plugging in the StickyTaskAssignor via the old
internal.task.assignor.classconfig, you will need to make sure that you are importing the new version of the StickyTaskAssignor when you switch over to the newtask.assignor.classconfig"
There was a problem hiding this comment.
I updated the migration guide. Feel free to suggest edits.
Co-authored-by: A. Sophie Blee-Goldman <ableegoldman@gmail.com>
Co-authored-by: A. Sophie Blee-Goldman <ableegoldman@gmail.com>
Co-authored-by: A. Sophie Blee-Goldman <ableegoldman@gmail.com>
Co-authored-by: A. Sophie Blee-Goldman <ableegoldman@gmail.com>
Co-authored-by: Matthias J. Sax <mjsax@apache.org>
Co-authored-by: A. Sophie Blee-Goldman <ableegoldman@gmail.com>
ableegoldman
left a comment
There was a problem hiding this comment.
Few more minor fixes but in general this is looking good
Co-authored-by: A. Sophie Blee-Goldman <ableegoldman@gmail.com>
Co-authored-by: A. Sophie Blee-Goldman <ableegoldman@gmail.com>
All public interface changes should be briefly mentioned in the upgrade guide. Reviewers: Matthias J. Sax <matthias@confluent.io>, Anna Sophie Blee-Goldman <sophie@responsive.dev>, Nick Telford <nick.telford@gmail.com>
All public interface changes should be briefly mentioned in the upgrade guide. Reviewers: Matthias J. Sax <matthias@confluent.io>, Anna Sophie Blee-Goldman <sophie@responsive.dev>, Nick Telford <nick.telford@gmail.com>
All public interface changes should be briefly mentioned in the
upgrade guide.
Committer Checklist (excluded from commit message)