KAFKA-4363: Documentation for sasl.jaas.config property#2316
KAFKA-4363: Documentation for sasl.jaas.config property#2316rajinisivaram wants to merge 2 commits intoapache:trunkfrom
Conversation
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
There was a problem hiding this comment.
Is there a good reason to use this instead of the new way? I wonder if we should stick to the new way when describing client config. And have a single place where we describe the static JAAS file way.
There was a problem hiding this comment.
@ijuma Thank you for the review. There is no real reason to use the static JAAS config file instead of the property for client configuration. But, for the documentation, JAAS config file format is more readable since it is multi-line. And it matches the equivalent broker configuration. I was hoping that specifying the property after the JAAS config file makes it obvious that the property is just a squashed version of the JAAS config file format. Does that make sense?
There was a problem hiding this comment.
I understand the reasoning, but I think we need to do a better job at guiding users towards what we consider the better option (and mention the advantage of not being restricted to one authentication user for all clients). I still think we could do what I suggested and then have a link to the static configuration with a blurb stating that it's similar to how it's done for the broker.
What do you think?
There was a problem hiding this comment.
@ijuma Thank you for the review. I have updated the doc.
There was a problem hiding this comment.
Thanks! Looks good by looking at the diff. Will check how it looks rendered and hopefully merge soon.
|
Refer to this link for build results (access rights to CI server needed): |
rajinisivaram
force-pushed
the
KAFKA-4363
branch
from
d1d5604 to
6023428
Compare
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
@rajinisivaram, I had a closer look at the SASL documentation and I'm wondering if there's any benefit to the general SASL instructions section for both broker and client. It seems like the mechanism-specific sections include most/all of the steps as well (but are more specific and hence more helpful). The mechanism-specific sections tend to refer back to the general section, but it seems a bit confusing. I merged this PR to trunk and 0.10.2, but I think it would be great to restructure the SASL docs so that people just read about the mechanisms that they are interested in and the multi-mechanism section if they need to support multiple ones. Thoughts? |
|
@ijuma Thank you merging this. I need to rebase the SCRAM documentation, so I can try to reduce duplication at the same time. |
|
Perfect! |
Author: Rajini Sivaram <rajinisivaram@googlemail.com> Reviewers: Ismael Juma <ismael@juma.me.uk> Closes #2316 from rajinisivaram/KAFKA-4363
Author: Rajini Sivaram <rajinisivaram@googlemail.com> Reviewers: Ismael Juma <ismael@juma.me.uk> Closes apache#2316 from rajinisivaram/KAFKA-4363
3 participants
No description provided.