Back to all reviewers

Document configuration constraints

apache/kafka
Based on 2 comments
Html

Configuration documentation must explicitly specify when settings should or should not be used, including conditional requirements and mutually exclusive options. This prevents misconfigurations and helps developers understand the proper context for each setting.

Configurations Html

Reviewer Prompt

Configuration documentation must explicitly specify when settings should or should not be used, including conditional requirements and mutually exclusive options. This prevents misconfigurations and helps developers understand the proper context for each setting.

When documenting configurations:

  • Clearly state when a configuration should NOT be used
  • Specify conditional requirements (e.g., “only applies when X is set”)
  • Explain mutually exclusive options
  • Provide context about when settings are relevant

Example:

controller.quorum.voters - Map of id/endpoint information for static voters. 
This should NOT be set if using dynamic quorums. See Static versus Dynamic 
KRaft Quorums for details.

group.protocol=streams - Additional ACLs are required for the new Streams 
rebalance protocol only when group.protocol=streams is set in the configuration.

This approach ensures developers can quickly understand configuration boundaries and avoid common setup mistakes.

2
Comments Analyzed
Html
Primary Language
Configurations
Category

Source Discussions