summaryrefslogtreecommitdiff
path: root/kafka/conn.py
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2019-03-23 18:01:18 -0700
committerDana Powers <dana.powers@gmail.com>2019-03-23 18:01:18 -0700
commitce9c1d2e2b8d85b2f6c3b2a2ebd280246cfea07f (patch)
treec45ff04c00b51ddbde2c4b940a2102db1a99ae7f /kafka/conn.py
parent8e2ed3ebb45f98e71b7c77fdd52472b815bb7ad2 (diff)
downloadkafka-python-ce9c1d2e2b8d85b2f6c3b2a2ebd280246cfea07f.tar.gz
Update sasl configuration docstrings
Diffstat (limited to 'kafka/conn.py')
-rw-r--r--kafka/conn.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/kafka/conn.py b/kafka/conn.py
index 52ed9d6..9353cf2 100644
--- a/kafka/conn.py
+++ b/kafka/conn.py
@@ -176,11 +176,11 @@ class BrokerConnection(object):
metric_group_prefix (str): Prefix for metric names. Default: ''
sasl_mechanism (str): Authentication mechanism when security_protocol
is configured for SASL_PLAINTEXT or SASL_SSL. Valid values are:
- PLAIN, GSSAPI. Default: PLAIN
+ PLAIN, GSSAPI, OAUTHBEARER.
sasl_plain_username (str): username for sasl PLAIN authentication.
- Default: None
+ Required if sasl_mechanism is PLAIN.
sasl_plain_password (str): password for sasl PLAIN authentication.
- Default: None
+ Required if sasl_mechanism is PLAIN.
sasl_kerberos_service_name (str): Service name to include in GSSAPI
sasl mechanism handshake. Default: 'kafka'
sasl_kerberos_domain_name (str): kerberos domain name to use in GSSAPI
@@ -215,7 +215,7 @@ class BrokerConnection(object):
'state_change_callback': lambda conn: True,
'metrics': None,
'metric_group_prefix': '',
- 'sasl_mechanism': 'PLAIN',
+ 'sasl_mechanism': None,
'sasl_plain_username': None,
'sasl_plain_password': None,
'sasl_kerberos_service_name': 'kafka',