[KAFKA-7281] Fix documentation and error message regarding cleanup.policy=[compact,delete]

• Type: Task
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 1.1.0
• Component/s: config
• Assignee: Unassigned
• Reporter: Patrik Kleindl
• Created: 13/Aug/18 08:52
• Updated: 13/Aug/18 08:52

Description

Issue as requested in: https://lists.apache.org/thread.html/621821e321b9ae5a8af623f5918edc4ceee564e0561009317fc705af@%3Cusers.kafka.apache.org%3E

1) The documentation at https://kafka.apache.org/documentation/ is missing the updated information regarding the "compact,delete" cleanup policy on topic level.
log.cleanup.policy on broker level
The default cleanup policy for segments beyond the retention window. A comma separated list of valid policies. Valid policies are: "delete" and "compact"
cleanup.policy on topic level
A string that is either "delete" or "compact".
 
2) Also the special notation for the command-line client should be noted:
./kafka-configs  --zookeeper broker0:2181 --alter --entity-type topics --entity-name test --add-config cleanup.policy=[compact,delete]

Completed Updating config for entity: topic 'test'.

3) The config command does not show this new notation in the error message:

./kafka-configs  --zookeeper broker0:2181 --alter --entity-type topics --entity-name test --add-config cleanup.policy=test

Error while executing config command with args '--zookeeper broker0:2181 --alter --entity-type topics --entity-name test --add-config cleanup.policy=test'

org.apache.kafka.common.config.ConfigException: Invalid value test for configuration cleanup.policy: String must be one of: compact, delete

at org.apache.kafka.common.config.ConfigDef$ValidString.ensureValid(ConfigDef.java:930)

at org.apache.kafka.common.config.ConfigDef$ValidList.ensureValid(ConfigDef.java:906)

at org.apache.kafka.common.config.ConfigDef.parseValue(ConfigDef.java:478)

at org.apache.kafka.common.config.ConfigDef.parse(ConfigDef.java:462)

at kafka.log.LogConfig$.validate(LogConfig.scala:299)

at kafka.zk.AdminZkClient.validateTopicConfig(AdminZkClient.scala:336)

at kafka.zk.AdminZkClient.changeTopicConfig(AdminZkClient.scala:348)

at kafka.zk.AdminZkClient.changeConfigs(AdminZkClient.scala:285)

at kafka.admin.ConfigCommand$.alterConfig(ConfigCommand.scala:133)

at kafka.admin.ConfigCommand$.processCommandWithZk(ConfigCommand.scala:100)

at kafka.admin.ConfigCommand$.main(ConfigCommand.scala:77)

at kafka.admin.ConfigCommand.main(ConfigCommand.scala)