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.2.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 deprecatedremoved, which means it will display a warning message saying that it's ignored.
--bootstrap-server option will be added: it has a parameter which is an endpoint to a broker (or a comma separated list of brokers)
--command-config option will be added: a file path to an admin client configuration properties file

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

AlterOperation (new)

0: Add
1: Set
2: Delete

Field Types

Double

A new type needs to be added to transfer quota values. Since the protocol classes in Kafka already utilize 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 implementation will be defined in org.apache.kafka.common.protocol.types with the other protocol types as on 8 bytes (as in IEEE 754) 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	DescribeQuotas Request

DescribeQuotas Request (Version: 0) => [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: 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_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

Alter Quotas

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	DescribeQuotas Request

DescribeQuotas Request (Version: 0) => [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: 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_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

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_

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
      resource_name => STRING
    quotaconfigs => quotaconfig_typename quotaconfig_value quota_operation
      quotaconfig_typename => INT8STRING
      quotaconfig_value => DOUBLE
      quota_operation => INT8STRING

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.
Set operation also does Add if needed to be backward compatible with the existing ConfigCommand semantics.

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

DescribeConfigs and AlterConfigs (SCRAM)

To enable describing and altering SCRAM credentials we will use the DescribeConfigs and AlterConfigs protocols. There are no changes in the protocol's structure but we will allow the USER resource type to be passed in the protocol. When this happens, the server will know that SCRAM configs are asked and will send them in the response. In case of AlterConfigs if a USER resource type is passed it will validate if there are only SCRAM credentials are changed. If not, then will fail with InvalidRequestException.

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 enum parameter to the configs so that it can specify the operation (set/add/delete) which needs to be executed.

Code Block

language	java
title	AlterConfigs Request

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

Request Semantics:

By default in the broker we parse an AlterConfigRequest version 0 with Unknown operation and handle it with the currently existing behavior. Version 1 requests however must have the operation set to other than Unknown, otherwise an InvalidRequestException will be thrown.
Set operation also does Add if needed to be backward compatible with the existing ConfigCommand semantics.

AdminClient APIs

:

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();
}

public enum QuotaType {
    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

Code Block

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

public static class Quota {
    public QuotaType typeMap<List<Resource>, KafkaFuture<Void>> results();
}
 
public class AlterConfigsOptions extends AbstractOptions<AlterConfigsOptions> {
    public doubleAlterConfigsOptions valuetimeoutMs(Integer timeoutMs);
    public QuotaSourceAlterConfigsOptions sourcevalidateOnly(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 enum QuotaType {
    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 byteApiError iderror();
    public StringCollection<Quota> quotaNameentries();
}
 
public enumclass AlterOperationDescribeQuotasRequest {
extends    ADD((byte) 0),
    SET((byte) 1),
    DELETE((byte) 2);

    AlterOperation(byte id);
    public byte id();
}

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 optionsAbstractRequest {
	
	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 AlterQuotasResultint alterQuotas(Map<ConfigResourceList, Collection<Quota>> configs, AlterQuotasOptions options);
}
public class DescribeQuotasOptions { 
    public DescribeQuotasOptions timeoutMs(Integer timeout);
}

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

public class AlterQuotasResult {
    public Map<List<Resource>, KafkaFuture<Void>> results();
}

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

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}
                      [--force FORCE] [--add-config ADDCONFIG]
                      [--delete-config DELETECONFIG]
                      (--entity-name ENTITYNAME | --entity-default)
                      (--describe | --alter)
                      (--bootstrap-server BOOTSTRAPSERVERS |
                      --adminclient.config CONFIGPROPERTIES |
                      --adminclient-property ADMINCLIENTPROPERTY)

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

optional arguments:
  -h, --help             show this help message and exit

No Format

usage: config-command [-h] --entity-type {topics,clients,users,brokers}
                      [--force FORCE] [--add-config ADDCONFIG]
   REQUIRED:      the       type       of     [--delete-config DELETECONFIG]
 entity
                       (--entity-name ENTITYNAME | --entity-default)
   (topics/clients/users/brokers)
  --force FORCE          Suppresses console prompts
  --add-config ADDCONFIG
      (--describe | --alter)
                 Key  Value  pairs (--bootstrap-server BOOTSTRAPSERVERS |
 of   configs   to  add.  Square
             --adminclient.config CONFIGPROPERTIES |
          brackets  can  be  used   to  group --adminclient-property ADMINCLIENTPROPERTY)

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

optional arguments:
  -h, --help values  which
                      show this help messagecontain and exitcommas: 'k1=v1,k2=[v1,v2,v2],k3=v3'.
  --entitydelete-type {topics,clients,users,brokers}
config DELETECONFIG
                         Config keys to remove  REQUIREDin  the following form: 'k1,
     the       type       of      entityk2'.

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

  --entity-name ENTITYNAME
                (topics/clients/users/brokers)
  --force FORCE      Name of entity (client Suppressesid/user consoleprincipal promptsname)
  --addentity-configdefault ADDCONFIG
      Default entity name for  clients/users (applies to
            Key  Value  pairs  of   configs   to corresponding add.entity type Square
in command line)

    You can specify only one in --alter, --describe

  --describe          brackets  can List be configs used for  tothe  groupgiven  valuesentity.  which(default:
                         contain commas: 'k1=v1,k2=[v1,v2,v2],k3=v3'.false)
  --delete-config DELETECONFIG
alter                Alter the        Config keys to remove in  the following form: 'k1,configuration for  the entity. (default:
                         k2'.false)

  REQUIRED. You can specify only one in --entitybootstrap-nameservers, and --entity-defaultadminclient.config

  --entitybootstrap-nameserver ENTITYNAMEBOOTSTRAPSERVER
                         The  Name of entity (client id/user principal name)
  --entity-defaultbroker  list  string  in  the  form
                   Default entity name for  clients/users (applies to HOST1:PORT1,HOST2:PORT2.
  --command-config COMMANDCONFIG
                      corresponding entity type inThe command line)

config  Youproperties can specifyfile only onefor in --alter, --describe

  --describe the
                List  configs  for  the  given Admin entity.  (default:
     Client.

Process finished with exit code 0

Output Format

No Format

                    false)
  --alter                Alter the configuration for  the entity. (default:
         CONFIGS FOR TOPIC topicA

             false)

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

  --bootstrap-server BOOTSTRAPSERVER
           Name   Value           The  broker  list  string  in  the  form
         Sensitive  Read-only              HOST1:PORT1,HOST2:PORT2.
  --command-config COMMANDCONFIGSource
                         Thecompression.type = configproducer  properties  file  for  the
                         Admin Client.

Process finished with exit code 0

Output Format

No Format

 false      false         Default config
                   message.format.version = 1.0-IV0                    CONFIGS FOR TOPIC topicA

           false      false         Default config
          Name   Value        file.delete.delay.ms = 6000                      Sensitive   Read-only  Default
          false      false   Dynamic topic config
    compression.typeleader.replication.throttled.replicas = producer                                 false      false  false   true
   false         Default config
      message.format.version = 1.0-IV0                 max.message.bytes = 1000012                false      false     true
       false      false        file.delete.delay.ms = 60000 Default config
                    min.compaction.lag.ms = 0              false      false     true
    leader.replication.throttled.replicas =          false      false         Default config
                false   message.timestamp.type = CreateTime false     true
                        max.message.bytes =false 1000012     false         Default config
                   false   min.insync.replicas = 1 false     true
                    min.compaction.lag.ms = 0            false      false         Default config
            false      false     true
 segment.jitter.ms = 0                message.timestamp.type = CreateTime                      false      false   false      falseDefault config
    true
                      min.insync.replicas = 1  preallocate = false                                    false      false       true
  Default config
                     segmentindex.jitterinterval.msbytes = 04096                                     false   false   false   false     true
 Default config
                min.cleanable.dirty.ratio = 0.5          preallocate = false                          false      false    false     Default falseconfig
     true
      unclean.leader.election.enable = false             index.interval.bytes = 4096                     false      false         Default falseconfig
      false     true
                min.cleanable.dirty.ratioretention.bytes = 10 0.5                                      false      false   Dynamic topic trueconfig
           unclean.leader.election.enable = false         delete.retention.ms = 86400000                         false      false  false   true
   false         Default config
             retention.bytes = 10            cleanup.policy = delete                         false      false    false
      false         Default config
      delete.retention.ms = 86400000                         flush.ms = 9223372036854775807      false      false     true
     false      false         Default config
      cleanup.policyfollower.replication.throttled.replicas = delete                                   false      false     true
 false         Default config
                      flush.ms = 9223372036854775807    segment.bytes = 1073741824                false      false     true
  follower.replication.throttled.replicas =     false      false         Default config
                     false      false  retention.ms = 604800000 true
                            segment.bytes = 1073741824 false      false         Default config
              false      false     true
      segment.ms = 604800000                     retention.ms = 604800000         false      false         Default config
       false message.timestamp.difference.max.ms = 9223372036854775807     false     true
            false      false         Default config
   segment.ms = 604800000                      flush.messages = 9223372036854775807        false      false     true
   false   message.timestamp.difference.max.ms = 9223372036854775807 false         Default config
           false      false     true
  segment.index.bytes = 10485760                         flush.messages = 9223372036854775807      false      false         Default falseconfig
      false     true
            producer.byte.rate = 1000        segment.index.bytes = 10485760                           false      false      false     Default trueuser

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, behavior of the the --zookeeper command line parameter will change. After this change it will print a warning message saying its ignored. Therefore 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-property or --adminclient.config. .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 will 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 12.1 0 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_KAFKA_CONFIG_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_KAFKA_CONFIG_COMMAND environment variablethe 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 a future version 2.0.

To ease the migration for users who are stuck with this command, the USE_OLD_KAFKA_CONFIG_COMMAND will be introduced.

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 33

New Version Current

Key

Status

Protocol Changes

Wire Format Types

Field Types

Double

Alter Quotas

Protocol Changes

Wire Format Types

Field Types

Double

Alter Quotas

AlterConfigs

DescribeConfigs and AlterConfigs (SCRAM)

AlterConfigs

AdminClient APIs

AdminClient APIs

Request API

Request API

New Command Line Interface

Help Message

New Command Line Interface

Help Message

Output Format

Output Format

Compatibility, Deprecation, And Migration Plan

Compatibility

Deprecation

Special Migration Tools

Test Plan

Space shortcuts

Child pages

Page History

Versions Compared

Old Version 33

New Version Current

Key

Status

Protocol Changes

Wire Format Types

Field Types

Double

Alter Quotas

Protocol Changes

Wire Format Types

Field Types

Double

Alter Quotas

AlterConfigs

DescribeConfigs and AlterConfigs (SCRAM)

AlterConfigs

AdminClient APIs

AdminClient APIs

Request API

Request API

New Command Line Interface

Help Message

New Command Line Interface

Help Message

Output Format

Output Format

Compatibility, Deprecation, And Migration Plan

Compatibility

Deprecation

Special Migration Tools

Test Plan