[KAFKA-14720] KIP-906: Tools migration guidelines

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.5.0
• Assignee: Federico Valeri
• Reporter: Federico Valeri
• Created: 15/Feb/23 12:31
• Updated: 21/Apr/23 16:26
• Resolved: 04/Apr/23 13:03

Description

The tools migration effort is ongoing and being tracked in KAFKA-14525. This is part of a bigger initiative to split the core module into multiple modules (e.g. storage, network, security, tools), which is being tracked in KAFKA-14524.

The plan is to migrate tools and related classes in a fully compatible way from kafka.tools and kafka.admin packages (core module) to org.apache.kafka.tools package (tools module).

While kicking off this activity, we identified a number of potential compatibility issues:

• Missing wrapper: some tools do not have a wrapper script. There are system tests that directly refer to the tool's fully qualified class name (FQCN) and expect the old package name when running on old Kafka releases. They are often used for troubleshooting or automation through the kafka-run-class.sh script which takes the FQCN as input parameter.
• SPI argument: some tools have arguments for setting a custom SPI implementation to be used in place of the default implementation. Any custom SPI implementation depends on the old package name.
• Broken tool: some tools do not work on supported releases.
• Core dependency: some tools require access to non-trivial core classes that should be migrated first.

See KIP-906 for more information.
https://cwiki.apache.org/confluence/display/KAFKA/KIP-906%3A+Tools+migration+guidelines

Issue Links

• is related to: KAFKA-14525 Move CLI tools from `core` to `tools` module