Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation bug: KafkaConsumer doc does not list all valid values for security_protocol #1990

Closed
pranavmarla opened this issue Jan 23, 2020 · 2 comments

Comments

@pranavmarla
Copy link

The KafkaConsumer documentation says the following about the security_protocol setting:
security_protocol (str) – Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT.
This indicates that there are only 2 valid values for security_protocol: PLAINTEXT and SSL.

However, further down in the same document, when talking about the sasl_mechanism setting, it says the following:
sasl_mechanism (str) – Authentication mechanism when security_protocol is configured for SASL_PLAINTEXT or SASL_SSL. Valid values are: PLAIN, GSSAPI, OAUTHBEARER.
This clearly implies that there are actually 2 more valid values for security_protocol, that are not mentioned above: SASL_PLAINTEXT and SASL_SSL.

This is confirmed by looking at the corresponding security_protocol section of the KafkaProducer documentation, which correctly lists all 4 valid values:
security_protocol (str) – Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. Default: PLAINTEXT.

@jeffwidman
Copy link
Collaborator

@pranavmarla want to submit a PR fixing this? Both KafkaConsumer and KafkaProducer inherit their security settings from KafkaClient (as long as the params are correctly plumbed through) so all three should list:

Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. Default: PLAINTEXT.

@pranavmarla
Copy link
Author

@jeffwidman Sorry, completely missed this -- thank you for fixing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants