kafka-admin-service 0.1.7

Kafka admin service class, provides basic management functions such as USER creation, USER deletion, USER listing all and USER password changing, TOPIC creation, TOPIC deletion, TOPIC listing all, and ACL creation, ACL deletion and ACL listing all.

kafka_admin_service

KAFKA管理类，提供用户创建、删除、列表查询、修改密码，提供主题创建、删除、列表查询，提供权限创建、删除、列表查询等基础管理功能。

安装

pip install kafka-admin-service

KafkaAdminService类方法

• add_acl
• change_password
• create_topic
• create_topic_and_topic_user
• create_user
• delete_acl
• delete_all_topics
• delete_all_users
• delete_topic
• delete_topic_user_acls
• delete_user
• get_acls
• get_topics
• get_user_scrams
• get_users
• update_user
• validate_user_password

返回值说明

由于KafkaAdminService在底层以“外部命令调用”的方式调用了kafka/bin/目录下的管理命令，所以返回值中大多会出现returncode/stdout/stderr等字段。其中returncode表示kafka管理命令执行后的退出值，stdout表示kafka管理命令执行后的输出，stderr表示kafka管理命令执行后的错误输出。

对于KAFKA服务器配置的要求

1. 要求KAFKA集群使用了scram认证。
2. 要求KAFKA依赖的zookeeper不使用认证。
3. 要求应用运行时的当前目录是Kafka的根目录，或使用workspace指定kafka的根目录。
4. 要求已创建正确的./config/scram.jaas文件。
5. 要求已创建正确的./config/scram.client.properties文件。
6. 要求应用服务能正常访问kafka服务器以及zookeeper服务器。

./config/scram.jaas模板

KafkaServer {
   org.apache.kafka.common.security.scram.ScramLoginModule required
   username="admin"
   password="xxxxxxxx";
};

KafkaClient {
   org.apache.kafka.common.security.scram.ScramLoginModule required
   username="admin"
   password="xxxxxxxx";
};

./config/scram.client.properties模板

security.protocol=SASL_PLAINTEXT
sasl.mechanism=SCRAM-SHA-256

常用的类初始化配置：kafka_admin_service_config.yml

加载配置文件，传递给KafkaAdminService创建方法。

zookeeper: localhost:2181
bootstrap_server: localhost:9092
workspace: /apprun/kafka/
command_config_file: "./config/scram.client.properties"
default_kafka_opts: "-Djava.security.auth.login.config=./config/scram.jaas"
topic_partitions: 16
topic_replication_factor: 3

版本历史

v0.1.1 2021/12/14

• First Release.

v0.1.3 2021/12/14

• 优化脚本依赖程序的路径检查和提示。
• 增加命令执行时间日志输出。

v0.1.6 2021/12/17

• 增加get_user_scrams方法，用于获取系统中用户的scram密码哈希信息。
• 增加validate_user_password方法，用于检验用户密码是否正确。

v0.1.7 2022/01/19

• 修正sdist在部分环境下安装时license文件缺失问题。
• 更新文档。