This page is meant as a template for writing a KIP. To create a KIP choose Tools->Copy on this page and modify with your content and replace the heading with the next KIP number and a description of your issue. Replace anything in italics with your own description.

Status

Current state: Under Discussion Rejected [One of "Under Discussion", "Accepted", "Rejected"]

Discussion thread: here

JIRA:

Jira

server	ASF JIRA
serverId	5aa69414-a9e9-3523-82ec-879b028fb15b
key	KAFKA-5722

Planned release: 1.1.0

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

...

The options accepted by kafka-configs.sh command will change:

--zookeeper will be deprecated, which means it will display a warning message saying that it's ignored.
a new --bootstrap-server option will be added
a new --adminclient.config option will be added

Protocol Changes

KIP-133 introduced the describe and alter admin protocols and KIP-140 a wire format representation for ResourceType. We will modify these to accommodate the new requirements.

Wire Format Types

ResourceType

```
0: Unknown
```
```
1: Any
```
```
2: Topic
```
```
3: Group
```
```
4: Broker
```
```
5: User (new)
```
```
6: Client (new)
```

QuotaType (new)

0: ProducerByteRate
1: ConsumerByteRate
2: RequestPercentage

QuotaSource (new)

0: Self
1: Default
2: Parent

Describe Quotas

To be able to implement the use cases of kafka-configs.sh where a quota is modified, like user, client or (user,client) we have to create a protocol to handle quota listings. The justification for a new protocol is that a quota is quite different from a broker or topic config because a quota can sometimes be identified a simple user, client or even a (user,client) tuple while a topic or a broker config can be identified only by the topic's name or the broker's ID.

Code Block

language	js
title	DescribeQuotas Request

DescribeQuotas Request (Version: 1) => [resource]
  resource => [quota_resource] [quota_type]
    quota_resource => type name
      type => INT8
      name => STRING
    quota_type => INT8

Request semantics:

Can be sent to any broker
If the name is empty it means that listing the default quota is asked. Responses will be returned the same way for defaults.
If the quota_type array is empty, all quotas are returned. Otherwise, quotas with the provided types are returned.
Authorization: "DescribeQuotas" can only be interpreted on the "Cluster" resource and represented by the DescribeConfigs ACL due to the similarity in use cases. Unauthorized requests will receive an appropriate AuthorizationFailed error code.

Code Block

language	js
title	DescribeQuotas Response

DescribeQuotas Response (Version: 1) => throttle_time_ms [resource]
  throttle_time_ms => INT32
  resource => [quota_resource] [quota]
    quota_resource => type name
      type => INT8
      name => STRING
    quota => error_code error_message [quota_entry]
      error_code => INT16
      error_message => NULLABLE_STRING
      quota_entry => quota_type quota_value quota_source
        quota_type => INT8
        quota_value => DOUBLE
        quota_source => INT8

...

removed, it's functionality won't be available. The design decision behind is that the ConfigCommand tool will be rewritten in the tools module which doesn't depend on the core module. This makes it hard to provide backward compatibility with the current ConfigCommand.
--bootstrap-server was added in
Jira
server ASF JIRA
columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId 5aa69414-a9e9-3523-82ec-879b028fb15b
key KAFKA-6494
and will be used here.
--adminclient.config option will be added and should be used similarly to other tools, such as --producer.config in the console-producer. This parses a config file and initializes the admin client used internally.
--adminclient-property option will be added. It is a key=value list that will be parsed by the command. It initializes the internal admin client.

A new tool, called scram-credentials.sh will be added. The need for this broker is when people use zookeeper as a credentials store for SCRAM (and currently users have no other option), then direct interaction with zookeeper is required to set up the initial credentials with inter-broker communication. The functionality of the tool will cover the following:

Add, remove and list SCRAM credentials directly with zookeeper
Will continue to use the --zookeeper option to specify the zookeeper host
Works similarly to the old config command. Examples:
- Add new credentials:
  bin/scram-credentials.sh --zookeeper localhost:2181 --add 'SCRAM-SHA-256=[iterations=8192,password=alice-secret],SCRAM-SHA-512=[password=alice-secret]' --username alice
- Describe credentials:
  bin/scram-credentials.sh --zookeeper localhost:2181 --describe --username alice
- Remove credentials:
  bin/scram-credentials.sh --zookeeper localhost:2181 --delete 'SCRAM-SHA-512' --username alice

Protocol Changes

KIP-133 introduced the describe and alter admin protocols and KIP-140 a wire format representation for ResourceType. We will modify these to accommodate the new requirements.

Wire Format Types

ResourceType

```
0: Unknown
```
```
1: Any
```
```
2: Topic
```
```
3: Group
```
```
4: Broker
```
```
5: User (new)
```
```
6: Client (new)
```

QuotaType (new)

0: ProducerByteRate
1: ConsumerByteRate
2: RequestPercentage

QuotaSource (new)

0: ClientInUser
1: DefaultClientInUser
2: User
3: ClientInDefaultUser
4: DefaultClientInDefaultUser
5: DefaultUser
6: Client
7: DefaultClient

Field Types

Double

A new type needs to be added to transfer quota values. Since the protocol classes in Kafka already uses ByteBuffers it is logical to use their functionality for serializing doubles. The serialization is basically a representation of the specified floating-point value according to the IEEE 754 floating-point "double format" bit layout. The ByteBuffer serializer writes eight bytes containing the given double value, in Big Endian byte order, into this buffer at the current position, and then increments the position by eight.

The implementation will be defined in org.apache.kafka.common.protocol.types with the other protocol types and it will have no default value much like the other types available in the protocol.

Describe Quotas

The justification for a new protocol is that a quota is quite different from a broker or topic config because a quota can sometimes be identified a simple user, client or even a (user,client) tuple while a topic or a broker config can be identified only by the topic's name or the broker's ID. Moreover quotas have their own well defined types.

Code Block

language	js
title	AlterQuotas DescribeQuotas Request

AlterQuotaDescribeQuotas Request (Version: 0) => validate_only [resource]
  validate_only => BOOLEAN[resource]
  resource => [quota_resource] [quota_type]
    quota_resource => type name
      type => INT8
      name => STRING
    quota => quota_type quota_value
      quota_type => INT8
      quota_value => DOUBLE

Request Semanticssemantics:

Can be sent to any broker
If name is empty it If the name is empty it means that altering a listing the default quota is asked. Responses will be returned the same way for defaults.
If the quota_type array is empty, all quotas are returned. Otherwise, quotas with the provided types are returned.
Authorization: "DescribeQuotas" can only be interpreted on the "Cluster" Authorization: "AlterQuotas" can only be interpreted on the "Cluster" resource and represented by the AlterConfigs DescribeConfigs ACL due to the similarity in use cases. Unauthorized requests will receive an appropriate AuthorizationFailed error code.
For tools that allow users to alter quota configs, a validation/dry-run mode where validation errors are reported but no creation is attempted is available via the validate_only parameter.

Code Block

language	js
title	AlterQuotas DescribeQuotas Response

AlterQuotasDescribeQuotas Response (Version: 0) => throttle_time_ms [resource]
  throttle_time_ms => INT32
  resource => [quota_resource] [quota]
    quota_resource => type name
      type => INT8
      name => STRING
    quota_collection => error_code error_message [quota_typeentry]
      error_code => INT16
      error_message => NULLABLE_STRING
      quota_typeentry => INT8

AdminClient APIs

Code Block

language	java
title	org.apache.kafka.clients.admin

/**
 * Represents a list of Resource objects that have a hierarchical relationship.
 * For instance one could represent relationship like "clientA of user1".
 */
public class ResourceList {
    public ResourceList(String user, String client);
    public ResourceList(ResourceType type, String resourceName);
 
    /**
     * Returns the list of resources in a top to bottom (first to last) order.
     */
    public List<Resource> resources();
}
 
/**
 * This class acts as an alias for a HashMap that maps a list of Resource
 * objects which represents hierarchical
 *
public class QuotaResourceMap extends HashMap<ResourceList, T> {
    public QuotaResourceMap(ResourceList key, T value);
    public QuotaResourceMap(Map<ResourceList, T>);
}
 
public class AdminClient {
    public DescribeQuotasResult describeQuotas(QuotaResourceMap<Collection<QuotaType>>, DescribeQuotasOptions options);
    public AlterQuotasResult alterQuotas(QuotaResourceMap<Collection<Quota>> configs, AlterQuotasOptions options);
}
public class DescribeQuotasOptions { 
    public DescribeQuotasOptions timeoutMs(Integer timeout);
}

public class DescribeQuotasResult {
    public QuotaResourceMap<KafkaFuture<Collection<Quota>>> values();
}
 
public class AlterQuotasOptions { 
    public AlterQuotasOptions timeoutMs(Integer timeout);
	public AlterQuotasOptions validateOnly(boolean validateOnly);
}

public class AlterQuotasResult {
    public QuotaResourceMap<KafkaFuture<Void>> results();
}

Request API

quota_type quota_value quota_source
        quota_type => INT8
        quota_value => DOUBLE
        quota_source => INT8

Alter Quotas

Code Block

language	js
title	AlterQuotas Request

AlterQuota Request (Version: 0) => validate_only [resource]
  validate_only => BOOLEAN
  resource => [quota_resource] [quota]
    quota_resource => type name
      type => INT8
      name => STRING
    quota => quota_type quota_value
      quota_type => INT8
      quota_value => DOUBLE

Request Semantics

Can be sent to any broker
If name is empty it means that altering a default quota is asked.
Authorization: "AlterQuotas" can only be interpreted on the "Cluster" resource and represented by the AlterConfigs ACL due to the similarity in use cases. Unauthorized requests will receive an appropriate AuthorizationFailed error code.
For tools that allow users to alter quota configs, a validation/dry-run mode where validation errors are reported but no creation is attempted is available via the validate_only parameter.
The AlterQuotas protocol has an incremental semantics. By this we mean that the request will update only those quotas which are sent in the request.
Removing quotas will be done by sending a NaN as the value.

Code Block

language	js
title	AlterQuotas Response

AlterQuotas Response (Version: 0) => throttle_time_ms [resource]
  throttle_time_ms => INT32
  resource => [quota_resource] [quota]
    quota_resource => type name
      type => INT8
      name => STRING
    quota => error_code error_message quota_type
      error_code => INT16
      error_message => NULLABLE_STRING
      quota_type => INT8

AlterConfigs

This request needs some change as currently the --add-config operation of ConfigCommand would do incremental operations in Zookeeper but the AlterConfigs protocol sets the whole properties object. The purpose of this change to add an boolean parameter to the request so that it can specify the behavior (incremental or set) which needs to be executed.

Code Block

language	java
title	AlterConfigs Request

AlterConfigs Request (Version: 1) => [resources] validate_only incremental_update
  validate_only => BOOLEAN
  incremental_update => BOOLEAN                                           // new addition
  resources => resource_type resource_name [configs]
    resource_type => INT8
    resource_name => STRING
    configs => config_name config_value
      config_name => STRING
      config_value => STRING

Request Semantics:

The default value of incremental_update is false. That means that the request will wipe the node's data and sets what is sent in the request.
Setting the incremental_update flag to true makes sure that existing configs are not deleted.
Deleting a config in incremental mode is done by sending an empty string as value.
Other existing semantics aren't changed.

AdminClient APIs

Code Block

language	java
title	org.apache.kafka.clients.admin

public static class Quota {
    public QuotaType type();
    public double value();
    public QuotaSource source

Code Block

language	java
title	org.apache.kafka.common.requests

public class QuotaList {
	public QuotaList(ApiError error, Collection<Quota> entries);

    public QuotaList(Collection<Quota> entries);

    public ApiError error();
    public Collection<Quota> entries();
}
 
public static class Quota {
    public QuotaType type();
    public double value();
    public QuotaSource source();
}

public static enum QuotaType {
    PRDOUCER_BYTE_RATE(0), CONSUMER_BYTE_RATE(1), REQUEST_PERCENTAGE(2);
	
    QuotaType(byte id);
    
    public byte id();
}

public static enum QuotaSource {
    SELF(0), DEFAULT(1), PARENT(2);
 
	QuotaSource(byte id);
 
    public byte id();
}
 
public class DescribeQuotasRequest extends AbstractRequest {
	
	public static Schema[] schemaVersions();
	public static DescribeQuotasRequest parse(ByteBuffer buffer, short version);
	public static class Builder extends AbstractRequest.Builder {
		public Builder(Map<List<Resource>>, Collection<QuotaType>> quotaSettings);
		public DescribeQuotasRequest build(short version);
	}
 
	public DescribeQuotasRequest(short version, Map<List<Resource>>, Collection<QuotaType>> quotaSettings);
	public DescribeQuotasRequest(Struct struct, short version);
 
	public Map<List<Resource>>, Collection<QuotaType>> quotaSettings();
}

public classenum DescribeQuotasResponse extendsQuotaType AbstractResponse {
	public  static Schema[] schemaVersions();

	public DescribeQuotasResponse(int throttleTimeMs, Map<List<Resource>>, QuotaType> configs);
	public DescribeQuotasResponse(Struct struct);

	public Map<List<Resource>>, DescribeConfigsResponse.Config> quotaConfigSettings();
}
 
public class AlterQuotasRequest extends AbstractRequest {
	public static Schema[] schemaVersions();
 
	public AlterQuotasRequest(short version, Map<List<Resource>>, AlterConfigsRequest.Config> configs, boolean validateOnly);
	public AlterQuotasRequest(Struct struct, short version);
 
	public Map<List<Resource>>, DescribeConfigsResponse.Config> configs();
}

New Command Line Interface

The kafka-config.sh command line interface will change a little bit in terms of help message and response format as we will use argparse4j for parsing arguments.

Help Message

 PRODUCER_BYTE_RATE((byte) 0, "producer_byte_rate"),
    CONSUMER_BYTE_RATE((byte) 1, "consumer_byte_rate"),
    REQUEST_PERCENTAGE((byte) 2, "request_percentage");

    QuotaType(byte id, String name);
    public byte id();
    public String quotaName();
}

public enum QuotaSource {
    CLIENT_OF_USER((byte) 0, "Client of user"),
    DEFAULT_CLIENT_OF_USER((byte) 1, "Default client of user"),
    USER((byte) 2, "User"),
    CLIENT_OF_DEFAULT_USER((byte) 3, "Client of default user"),
    DEFAULT_CLIENT_OF_DEFAULT_USER((byte) 4, "Default client of default user"),
    DEFAULT_USER((byte) 5, "Default user"), CLIENT((byte) 6, "Client"),
    DEFAULT_CLIENT((byte) 7, "Default client");

    QuotaSource(byte id, String description);
    public byte id();
    public String description();
}
 
/**
 * Makes sure that the list of resources that is used as key in a hashmap is immutable and has a fixed implementation for the hashCode.
 */
public class ConfigResourceList {
    public List<ConfigResource> getResourceList();
 
public class AdminClient {
    public DescribeQuotasResult describeQuotas(Map<ConfigResourceList, Collection<QuotaType>>, DescribeQuotasOptions options);
    public AlterQuotasResult alterQuotas(Map<ConfigResourceList, Collection<Quota>> configs, AlterQuotasOptions options);
}
public class DescribeQuotasOptions extends AbstractOptions<DescribeQuotasOptions>  { 
    public DescribeQuotasOptions timeoutMs(Integer timeout);
}

public class DescribeQuotasResult {
    public Map<List<Resource>, KafkaFuture<Collection<Quota>>> values();
}
 
public class AlterQuotasOptions extends AbstractOptions<AlterQuotasOptions> { 
    public AlterQuotasOptions timeoutMs(Integer timeout);
	public AlterQuotasOptions validateOnly(boolean validateOnly);
}

public class AlterQuotasResult {
    public Map<List<Resource>, KafkaFuture<Void>> results();
}
 
public class AlterConfigsOptions extends AbstractOptions<AlterConfigsOptions> {
    public AlterConfigsOptions timeoutMs(Integer timeoutMs);
    public AlterConfigsOptions validateOnly(boolean validateOnly);
    public boolean shouldValidateOnly();
    public AlterConfigsOptions incrementalUpdate(boolean incrementalUpdate); // new
    public boolean shouldUpdateIncrementally(); // new
}

Request API

Code Block

language	java
title	org.apache.kafka.common.requests

public class QuotaCollection {
	public QuotaCollection(ApiError error, Collection<Quota> entries);

    public QuotaCollection(Collection<Quota> entries);

    public ApiError error();
    public Collection<Quota> entries();
}
 
public class DescribeQuotasRequest extends AbstractRequest {
	
	public static Schema[] schemaVersions();
	public static DescribeQuotasRequest parse(ByteBuffer buffer, short version);
 
	public static class Builder extends AbstractRequest.Builder {
		public Builder(Map<List<Resource>, Collection<QuotaType>> quotaSettings);
		public DescribeQuotasRequest build(short version);
	}
 
	public DescribeQuotasRequest(short version, Map<List<Resource>, Collection<QuotaType>> quotaSettings);
	public DescribeQuotasRequest(Struct struct, short version);
 
	public Map<List<Resource>, Collection<QuotaType>> quotaTypes();
}

public class DescribeQuotasResponse extends AbstractResponse {
	public static Schema[] schemaVersions();

	public DescribeQuotasResponse(int throttleTimeMs, Map<ConfigResourceList, KafkaFuture<Collection<Quota>>>);
	public DescribeQuotasResponse(Struct struct);

	public Map<List<Resource>, QuotaCollection> quotas();
}
 
public class AlterQuotasRequest extends AbstractRequest {
	public static Schema[] schemaVersions();
 
	public static class Builder extends AbstractRequest.Builder {
		public Builder(Map<List<Resource>, QuotaCollection> quotaSettings);
		public DescribeQuotasRequest build(short version);
	}
 
	public AlterQuotasRequest(short version, Map<List<Resource>, QuotaCollection> quotas, boolean validateOnly);
	public AlterQuotasRequest(Struct struct, short version);
 
	public Map<List<Resource>, QuotaCollection> quotas();
}
 
public class AlterQuotasResponse extends AbstractResponse {
	public static Schema[] schemaVersions();
 
	public AlterQuotasRequest(short version, Map<List<Resource>, ApiError> quotas, boolean validateOnly);
	public AlterQuotasRequest(Struct struct, short version);
 
	public Map<List<Resource>, ApiError> errors();
    public int throttleTimeMs();
}

New Command Line Interface

The kafka-config.sh command line interface will change a little bit in terms of help message and response format as we will use argparse4j for parsing arguments.

Help Message

No Format

usage: config-command [-h] --entity-type {topics,clients,users,brokers}

No Format

usage: config-command [-h] --entity-type {topics,clients,users,brokers}
                      [--force FORCE] [--add-config ADDCONFIG]
                      [--delete-config DELETECONFIG]
                      (--entity-name ENTITYNAME | --entity-default)
                      (--describe | --alter)
                      (--bootstrap-servers BOOTSTRAPSERVERS |
                      --config.properties CONFIGPROPERTIES)

Change configs for topics, clients, users, brokers dynamically.

optional arguments:
  -h, --help             show this help message and exit
  --entity-type {topics,clients,users,brokers}
                         REQUIRED:      the       type       of      entity
                         (topics/clients/users/brokers)
  --force FORCE          Suppresses console prompts
  --add-config ADDCONFIG
                         Key  Value  pairs  of   configs   to  add.  Square
                         brackets  can  be  used   to  group  values  which
                         contain commas: 'k1=v1,k2=[v1,v2,v2],k3=v3'.
  --delete-config DELETECONFIG
                         Config keys to remove in  the following form: 'k1,
   [--force FORCE] [--add-config ADDCONFIG]
                      k2'.

  You can specify only one in [--delete-config DELETECONFIG]
                      (--entity-name andENTITYNAME | --entity-default
)
  --entity-name ENTITYNAME
                   (--describe | --alter)
    Name of entity (client id/user principal name)
  --entity-default       Default entity name for  clients/users (applies to (--bootstrap-server BOOTSTRAPSERVERS |
                      --adminclient.config   corresponding entity type in command line)
CONFIGPROPERTIES |
  You can specify only one in --alter, --describe

  --describe           --adminclient-property  List  ADMINCLIENTPROPERTY)

Change configs  for topics, theclients, users, givenbrokers  entitydynamically.  (default

optional arguments:
  -h, --help             show this help message and exit
    false)--entity-type {topics,clients,users,brokers}
  --alter                Alter the configuration for  the entity. (defaultREQUIRED:
      the       type       of      false)entity

    You can specify only one in --bootstrap-servers, --config.properties

  --bootstrap-servers BOOTSTRAPSERVERS
            (topics/clients/users/brokers)
  --force FORCE          Suppresses  REQUIRED: The  broker  list  string  in  the  form
console prompts
  --add-config ADDCONFIG
                         Key  Value  pairs  of   configs   to  HOST1:PORT1,HOST2:PORT2.add.  Square
  --config.properties CONFIGPROPERTIES
                      brackets  can REQUIRED: be The used config  propertiesto  filegroup  forvalues  thewhich
                         Admin Client.

Process finished with exit code 0

Output Format

No Format

contain commas: 'k1=v1,k2=[v1,v2,v2],k3=v3'.
  --delete-config DELETECONFIG
                         Config keys to remove in  the following form: 'k1,
                  CONFIGS FOR TOPIC topicA

    k2'.

  You can specify only one in --entity-name       and --entity-default

  --entity-name ENTITYNAME
                  Name   Value    Name of entity (client id/user principal name)
  --entity-default       Default entity name for  clients/users (applies to
      Sensitive  Read-only  Default
               corresponding entity type in command line)

  You can specify compression.typeonly =one producerin --alter, --describe

  --describe             List  configs  for  the  given  entity.  (default:
    false      false     true
          false)
  --alter       message.format.version = 1.0-IV0       Alter the configuration for  the   entity. (default:
                   false      false)

  REQUIRED. You can true
specify only one in --bootstrap-servers, --adminclient.config

  --bootstrap-server BOOTSTRAPSERVER
             file.delete.delay.ms = 60000          The  broker  list  string  in  the  form
              false      false     trueHOST1:PORT1,HOST2:PORT2.
  --command-config  leader.replication.throttled.replicas =COMMANDCONFIG
                         The  config  properties  file  for  the
         false      false     true
     Admin Client.

Process finished with exit code 0

Output Format

No Format

             max.message.bytes = 1000012                                  false   CONFIGS FOR TOPIC falsetopicA

     true
                    min.compaction.lag.ms = 0          Name   Value                                Sensitive  Read-only     false       false     trueSource
                   message.timestamp.      compression.type = CreateTimeproducer                                 false      false       true
  Default config
                   minmessage.insyncformat.replicasversion = 1.0-IV0                                  false      false      false   Default  trueconfig
                        segment.jitterfile.delete.delay.ms = 06000                                        false      false   Dynamic topic trueconfig
    leader.replication.throttled.replicas =                         preallocate = false               false      false         Default config
     false      false     true
        max.message.bytes = 1000012           index.interval.bytes = 4096                     false      false         Default falseconfig
      false     true
                min.cleanablecompaction.dirtylag.ratioms = 0.5                                        false      false     true
    Default config
      unclean.leader.election.enable = false           message.timestamp.type = CreateTime                       false      false  false   true
   false         Default config
             retention.bytes = 10       min.insync.replicas = 1                              false      false    false
      false         Default config
      delete.retention.ms = 86400000                segment.jitter.ms = 0               false      false     true
              false      false       cleanup.policy  =Default deleteconfig
                              preallocate = false   false      false     true
                      false      false     flush.ms = 9223372036854775807  Default config
                   false  index.interval.bytes = 4096  false     true
  follower.replication.throttled.replicas =                           false      false         falseDefault config
     false     true
      min.cleanable.dirty.ratio = 0.5                    segment.bytes = 1073741824                false      false         falseDefault config
     false     true
    unclean.leader.election.enable = false                          retention.ms = 604800000        false      false         Default config
        false      false     true
       retention.bytes = 10                      segment.ms = 604800000               false      false   Dynamic topic config
      false      false     true
      messagedelete.timestampretention.difference.max.ms = 922337203685477580786400000                      false      false     true
false      false         Default config
                      flush.messages     cleanup.policy = 9223372036854775807 delete                                   false      false         Default true
config
                                 segment.index.bytes = 10485760                                 false      false     true

As seen above, the describe format becomes more organized and it will also return default properties (as the protocol currently supports that). In case of alter we will also do an extra describe after executing the alter and print the most fresh state.

Compatibility, Deprecation, And Migration Plan

Compatibility

The behavior of the --zookeeper command line parameter will change. After this change it will print a warning message saying its ignored. Therefore every user will need to change --zookeeper to --bootstrap-servers.

             flush.ms = 9223372036854775807                      false      false         Default config
  follower.replication.throttled.replicas =                                          false      false         Default config
                            segment.bytes = 1073741824                               false      false         Default config
                             retention.ms = 604800000                                false      false         Default config
                               segment.ms = 604800000                                false      false         Default config
      message.timestamp.difference.max.ms = 9223372036854775807                      false      false         Default config
                           flush.messages = 9223372036854775807                      false      false         Default config
                      segment.index.bytes = 10485760                                 false      false         Default config
                       producer.byte.rate = 1000                                     false      false           Default user

As seen above, the describe format becomes more organized and it will also return default properties (as the protocol currently supports that). In case of alter we will also do an extra describe after executing the alter and print the most fresh state.

Compatibility, Deprecation, And Migration Plan

Compatibility

Firstly, the --zookeeper option will be removed from kafka-configs.sh and the backing code will be replaced. Therefore every user will need to change --zookeeper to --bootstrap-servers, --adminclient-property or --adminclient.config. SCRAM update will be done by the newly introduced scram-credentials.sh tool. Other existing behavior will be kept.

Secondly, users as of this KIP would be able to describe all topics or brokers in one step but can't do it for clients and users. For those who have this use case would still need to use the old command for a while (see below). The reason for this change is currently MetadataRequest provides enough information about topics and brokers so it's possible to describe all of them in one step but there's no such information about clients and users.

Finally, backward compatibilty (for instance a 2.0 Also backward compatibilty (saying an 1.1 client wants to admin a 1.0 server) will be impacted as some of the protocols are newly created and doesn't exist in old servers. In these cases users should continue using the scala version of the ConfigCommand by putting the core jar on their classpath and defining the USE_OLD_COMMAND=true environment variable. This variable will set the main class to the old command in the config and invokes that. This way the environment variable ensures that users who aren't able to use the new command currently would need to make minimal changes in order to continue using it. the protocols are newly created and doesn't exist in old servers. In these cases users should continue using the scala version of the ConfigCommand by putting the core jar on their classpath.

The old Alternatively though the command could be launched through kafka-run-class.sh like this:

...

From the compatibility point of view there might be a bigger impact as mentioned above. Since the command now uses the wire protocols (including some newly introduced ones) the backward compatibility will be impacted. That means that a user can't use a 12.1 0 client to administrate a 1.0 broker as in the older broker some of the wire protocols don't exist. This again should be acceptable most of the users as most of the admin commands require the core jar on the classpath which means that most of the time the commands are executed from an environment with the same version of the brokers. In the remaining cases users will have to change to use kafka-run-class or the USE_OLD_COMMAND environment variableof the brokers. Therefore the old tool should still be available.

Deprecation

kafka.admin.ConfigCommand will print a warning message saying it is deprecated and will be removed in version 2.0.To ease the migration for users who are stuck with this command, the USE_OLD_COMMAND will be introduceda future version.

Special Migration Tools

There are no tools required.

...

The current --zookeeper option will be disabled removed with this change as it has minimal impact on the current users.

Listing multiple users' and clients' quotas at once won't be possible. If this is required, users would need to use the old tool.

Test Plan

Most of the functionality can be covered with end-to-end tests. There will be unit tests also to verify the protocol and the broker side logic.

...

Space shortcuts

Child pages

Versions Compared

Old Version 9

New Version Current

Key

Status

Protocol Changes

Wire Format Types

Describe Quotas

Protocol Changes

Wire Format Types

Field Types

Double

AdminClient APIs

Request API

Alter Quotas

AlterConfigs

AdminClient APIs

New Command Line Interface

Help Message

Request API

New Command Line Interface

Help Message

Output Format

Output Format

Compatibility, Deprecation, And Migration Plan

Compatibility

Compatibility, Deprecation, And Migration Plan

Compatibility

Deprecation

Special Migration Tools

Test Plan

Space shortcuts

Child pages

Page History

Versions Compared

Old Version 9

New Version Current

Key

Status

Protocol Changes

Wire Format Types

Describe Quotas

Protocol Changes

Wire Format Types

Field Types

Double

AdminClient APIs

Request API

Alter Quotas

AlterConfigs

AdminClient APIs

New Command Line Interface

Help Message

Request API

New Command Line Interface

Help Message

Output Format

Output Format

Compatibility, Deprecation, And Migration Plan

Compatibility

Compatibility, Deprecation, And Migration Plan

Compatibility

Deprecation

Special Migration Tools

Test Plan