This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • KIP-524: Allow users to choose config source when describing configs
Skip to end of metadata
Go to start of metadata

Status

Current state: Adopted

Discussion thread: here

JIRA: KAFKA-9040 - Getting issue details... STATUS

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

Currently users can use view dynamic broker configs using the kafka-configs.sh tool. It is sometimes convenient to be able to see static configurations through the same tool. This KIP enables a way to view all configurations through this tool.

Proposed Changes

By default, when using `--describe --entity-type brokers`, the config tool will only print dynamic configurations. We will add two flags to distinguish the set of configs to view.

  • `–dynamic`: Print only dynamically overridden configurations. 
  • `–all`: Print all available configurations and their sources.

This current behavior is equivalent to using the `–dynamic` option. If nothing is specified, this is assumed.

Public Interfaces

As described above, we will an optional flag to specify the set of configs to display when `kafka-config.sh --describe` is used. 

For example, to print all configurations for a given broker, a user can do the following:

kafka-configs.sh --describe --all --entity-type brokers --entity-name 0

For `--entity-default`, there is no difference between `–all` and `–dynamic`. 

kafka-configs.sh --describe --all --entity-type brokers --entity-default

Compatibility, Deprecation, and Migration Plan

We will retain the current behavior by default. If no option is specified, we will assume `–dynamic`. 

Rejected Alternatives

None yet.

  • No labels