You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Status

Current state: Draft

Discussion thread:

JIRA:

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

Motivation

In a number of places our code uses racially charged terms such as "blacklist" and "whitelist". This is a proposal to replace them with neutral terms such as "blocklist" and "allowlist".

This follows the model other open source projects set forth, such as https://chromium.googlesource.com/chromium/src/+/master/styleguide/inclusive_code.md#racially-neutral

Public Interfaces

Affected configurations and command line arguments will be renamed. The old name will continue to be supported for backwards compatibility, but deprecated.

List of affected configurations

componenttypeexistingnew config
JmxReporterconfig
metrics.jmx.blacklist
metrics.jmx.blocklist
JmxReporterconfig
metrics.jmx.whitelist
metrics.jmx.allowlist
MirrorMaker 2config
topics.blacklist
topics.blocklist
MirrorMaker 2config
groups.blacklist
groups.blocklist
MirrorMaker 2config
config.properties.blacklist
config.properties.blocklist
kafka-mirror-maker CLI
command line argument
--whitelist
--allowlist
Kafka Connect Transformsconfig
blacklist
blocklist
Kafka Connect Transformsconfig
whitelist
allowlist
kafka-console-consumer CLIcommand line argument
--whitelist
--allowlist

kafka-replica-verification CLI

command line argument
--topic-white-list
--topic-allow-list

Proposed Changes

In addition to the public interface changes above, internal APIs and other occurrences in code (e.g. method, variable names, comments, and log messages) will be updated accordingly.

Compatibility, Deprecation, and Migration Plan

Existing configuration names will be deprecated but will continue to work for backwards compatibility. 

Rejected Alternatives

N/A

  • No labels