[KAFKA-15949] Improve the KRaft metadata version related messages

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.6.0
• Fix Version/s: 3.8.0
• Assignee: PoAn Yang
• Reporter: Jakub Scholz
• Created: 29/Nov/23 22:23
• Updated: 26/Mar/24 12:09
• Resolved: 26/Mar/24 12:09

Description

Various error messages related to KRaft seem to use very different style and formatting. Just for example in the StorageTool Scala class, there are two different examples:

• Must specify a valid KRaft metadata version of at least 3.0.
  • Refers to "metadata version"
  • Refers to the version as 3.0 (although strictly speaking 3.0-IV0 is not valid for KRaft)
• SCRAM is only supported in metadataVersion IBP_3_5_IV2 or later.
  • Talks about "metadataVersion"
  • Refers to "IBP_3_5_IV2" instead of "3.5" or "3.5-IV2"

Other pieces of Kafka code seem to also talk about "metadata.version" for example.

For users, it would be nice if the style and formats used were the same everywhere. Would it be worth unifying messages like this? If yes, what would be the preferred style to use?

Issue Links

• links to: GitHub Pull Request #15505