diff --git a/docs/apidoc/KafkaAdmin.rst b/docs/apidoc/KafkaAdmin.rst new file mode 100644 index 000000000..f8c80ab45 --- /dev/null +++ b/docs/apidoc/KafkaAdmin.rst @@ -0,0 +1,5 @@ +KafkaAdmin +=========== + +.. autoclass:: kafka.admin.KafkaAdmin + :members: diff --git a/docs/apidoc/modules.rst b/docs/apidoc/modules.rst index 947788713..1173cfeed 100644 --- a/docs/apidoc/modules.rst +++ b/docs/apidoc/modules.rst @@ -5,6 +5,7 @@ kafka-python API KafkaConsumer KafkaProducer + KafkaAdmin KafkaClient BrokerConnection ClusterMetadata diff --git a/kafka/admin/kafka.py b/kafka/admin/kafka.py index e78bdbfa7..37a80a70d 100644 --- a/kafka/admin/kafka.py +++ b/kafka/admin/kafka.py @@ -18,6 +18,13 @@ class KafkaAdmin(object): """An class for administering the kafka cluster. + Warning: + This is an unstable interface that was recently added and is subject to + change without warning. In particular, many methods currently return + raw protocol tuples. In future releases, we plan to make these into + nicer, more pythonic objects. Unfortunately, this will likely break + those interfaces. + The KafkaAdmin class will negotiate for the latest version of each message protocol format supported by both the kafka-python client library and the kafka broker. Usage of optional fields from protocol versions that are not supported by the broker will result in UnsupportedVersionError exceptions.