Add SASL_PLAINTEXT and SASL_SSL to valid values in security protocol …

…documentation. (#768)
aio-libs · Aug 25, 2021 · 9eb6379 · 9eb6379
1 parent 04ca511
commit 9eb6379
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/CHANGES/768.doc b/CHANGES/768.doc
@@ -0,0 +1 @@
+Add SASL_PLAINTEXT and SASL_SSL to valid values in security protocol attribute.
diff --git a/aiokafka/client.py b/aiokafka/client.py
@@ -73,7 +73,8 @@ class AIOKafkaClient:
             If set to 'auto', will attempt to infer the broker version by
             probing various APIs. Default: auto
         security_protocol (str): Protocol used to communicate with brokers.
-            Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT.
+            Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
+            Default: PLAINTEXT.
         ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping
             socket connections. For more information see :ref:`ssl_auth`.
             Default: None.

diff --git a/aiokafka/consumer/consumer.py b/aiokafka/consumer/consumer.py
@@ -163,7 +163,8 @@ class AIOKafkaConsumer:
             If set to 'auto', will attempt to infer the broker version by
             probing various APIs. Default: auto
         security_protocol (str): Protocol used to communicate with brokers.
-            Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT.
+            Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
+            Default: PLAINTEXT.
         ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping
             socket connections. Directly passed into asyncio's
             `create_connection`_. For more information see :ref:`ssl_auth`.

diff --git a/aiokafka/producer/producer.py b/aiokafka/producer/producer.py
@@ -131,7 +131,8 @@ class AIOKafkaProducer:
             If set to 'auto', will attempt to infer the broker version by
             probing various APIs. Default: auto
         security_protocol (str): Protocol used to communicate with brokers.
-            Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT.
+            Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
+            Default: PLAINTEXT.
         ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping
             socket connections. Directly passed into asyncio's
             `create_connection`_. For more information see :ref:`ssl_auth`.