kafka-configs.sh: add, remove and describe dynamic configs of topics, brokers, clients, users and groups
kafka-configs.sh [options]
Options you will use
--bootstrap-server <String: server to connect to>- REQUIRED: the Kafka broker(s) to connect to, host:port[,host:port]. Give more than one: the first may be the broker that is down.
--command-config <String: config file>- a properties file with client configs for the admin client (TLS, SASL...).
--entity-type <String>- topics, brokers, broker-loggers, clients, users, ips, client-metrics, groups.
--entity-name <String>- the topic, the broker id...
--entity-default- the cluster-wide default (brokers, clients, users, ips).
--describe- list the dynamic configs of the entity.
--all- with --describe: every config, static and default ones too, with source and synonyms.
--alter- change configs.
--add-config <String>- k1=v1,k2=[v1,v2,v2],k3=v3 to set.
--add-config-file <String>- a properties file with the configs to set.
--topic <String: topic>- the topic's name: short for --entity-type topics --entity-name.
--delete-config <String>- config names to remove (the value is inherited again).
Examples
$ kafka-configs.sh --bootstrap-server kafka-1:9092 --alter --entity-type topics --entity-name orders --add-config retention.ms=86400000a topic override
$ kafka-configs.sh --bootstrap-server kafka-1:9092 --describe --entity-type brokers --entity-name 1 --allevery broker config with its source
Gotchas
- Precedence: topic override > per-broker > cluster default (--entity-default) > server.properties > Kafka default.
- Read-only broker configs (log.dirs, node.id, process.roles) are refused: "Cannot update these configs dynamically".
- With ELR on, min.insync.replicas may only be set cluster-wide or per topic.
Taught in
On the blog
Try kafka-configs.sh in a real terminal Free, in your browser - a real Ubuntu terminal to try it in, with missions that check your work.