Ron Dagostino created KAFKA-10076:
-------------------------------------

             Summary: Doc prefixed vs. non-prefix configs
                 Key: KAFKA-10076
                 URL: https://issues.apache.org/jira/browse/KAFKA-10076
             Project: Kafka
          Issue Type: Improvement
          Components: docs
            Reporter: Ron Dagostino


Listener-prefixed configs have higher precedence than unprefixed configs. For 
example,  {{listener.name.default.sasl.enabled.mechanisms}} has higher 
precedence (and overrides any value of) {{sasl.enabled.mechanisms}}.  The docs 
for {{sasl.enabled.mechanism}} says nothing about this, and while it may be 
mentioned elsewhere (I did not do an exhaustive search, so I don’t really 
know), it feels like this could be better documented.  In particular, I think 
there could be two general changes that would be useful:

# If a particular config can be overridden by a prefixed version, then the 
specific documentation for that config could explicitly state this (e.g. add 
something to the {{sasl.enabled.mechanisms}} documentation is just one example).
# Add a general paragraph somewhere that describes the concept of prefixed 
configs and how they work/what their precedence is relative to unprefixed 
configs, and (maybe?) the list of configs that can be prefixed.  (Again, I 
didn’t do an exhaustive search for this, so it might already exist.)



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to