Skip to content

Latest commit

 

History

History
127 lines (91 loc) · 3.09 KB

kafka-admin-ConfigCommand.adoc

File metadata and controls

127 lines (91 loc) · 3.09 KB

ConfigCommand Command-Line Tool

kafka.admin.ConfigCommand is a command-line tool that…​FIXME

ConfigCommand can be executed using kafka-configs shell script (i.e. bin/kafka-configs.sh or bin\windows\kafka-configs.bat).

// Triggers alterBrokerConfig
./bin/kafka-configs.sh \
  --bootstrap-server :9092 \
  --alter \
  --entity-type brokers \
  --entity-name 0 \
  --add-config advertised.listeners=plaintext://:9092
// Triggers processBrokerConfig
./bin/kafka-configs.sh \
  --bootstrap-server :9092 \
  --describe \
  --entity-type brokers \
  --entity-name 0

alterBrokerConfig Method

alterBrokerConfig(
  adminClient: JAdminClient,
  opts: ConfigCommandOptions,
  entityName: String)

alterBrokerConfig…​FIXME

Note
 alterBrokerConfig is used exclusively when ConfigCommand is requested to processBrokerConfig (with alter action).

processBrokerConfig Internal Method

processBrokerConfig(opts: ConfigCommandOptions): Unit

processBrokerConfig…​FIXME

Note
 processBrokerConfig is used exclusively when ConfigCommand standalone application is executed (without zookeeper command-line option).

Executing Standalone Application — main Method

main(args: Array[String]): Unit

main is the entry point of the ConfigCommand standalone application when launched on command line (e.g. from bin/kafka-configs.sh).

main…​FIXME

processCommandWithZk Internal Method

processCommandWithZk(zkConnectString: String, opts: ConfigCommandOptions): Unit

processCommandWithZk…​FIXME

Note
 processCommandWithZk is used when…​FIXME

alterConfig Internal Method

alterConfig(
  zkClient: KafkaZkClient,
  opts: ConfigCommandOptions,
  adminZkClient: AdminZkClient): Unit

alterConfig…​FIXME

Note
 alterConfig is used when…​FIXME

describeConfig Internal Method

describeConfig(
  zkClient: KafkaZkClient,
  opts: ConfigCommandOptions,
  adminZkClient: AdminZkClient): Unit

describeConfig…​FIXME

Note
 describeConfig is used when…​FIXME

describeBrokerConfig Internal Method

describeBrokerConfig(
  adminClient: JAdminClient,
  opts: ConfigCommandOptions,
  entityName: String): Unit

describeBrokerConfig…​FIXME

Note
 describeBrokerConfig is used exclusively when ConfigCommand is requested to processBrokerConfig (with describe action).

brokerConfig Internal Method

brokerConfig(
  adminClient: JAdminClient,
  entityName: String,
  includeSynonyms: Boolean): Seq[ConfigEntry]

brokerConfig…​FIXME

Note
 brokerConfig is used when ConfigCommand is requested to alterBrokerConfig and describeBrokerConfig.