Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Change the "blacklist / whitelist" nomenclature #449

Closed
Tracked by #2589 ...
tlfeng opened this issue Mar 15, 2022 · 0 comments · Fixed by #509
Closed
Tracked by #2589 ...

[FEATURE] Change the "blacklist / whitelist" nomenclature #449

tlfeng opened this issue Mar 15, 2022 · 0 comments · Fixed by #509
Assignees
Labels
breaking Involves a breaking change to a release enhancement New feature or request upcoming release Don't merge until the version or feature is available v2.0.0
Milestone

Comments

@tlfeng
Copy link
Contributor

tlfeng commented Mar 15, 2022

Is your feature request related to a problem?
OpenSearch repository is going to replace the terminology "blacklist / whitelist" with "denylist / allowlist".
issue: opensearch-project/OpenSearch#1483, with the plan for its terminology replacement.

The existing OpenSearch REST APIs and settings will be deprecated in version 2.0, and eventually be removed in at least version 3.0. Please prepare for the nomenclature change in advance.

What solution would you like?
Replace the terminology "blacklist / whitelist" with "denylist / allowlist"

  1. Inform the user about the nomenclature change in advance in the documentation.
  2. Replace all the internal usages with "master" word in the code base.

The impact to the users is concentrated in a setting name change reindex.remote.whitelist. The issue opensearch-project/OpenSearch#1547 shows all the detailed code change.

Users are still able to use the setting reindex.remote.whitelist, but it will result a deprecation warning stored in log file.
It's suggested to use the new name reindex.remote.allowlist.

Expected behavior of the setting:

  • If the new setting is configured, value of the old setting will be ignored.
  • If the new setting is not configured, value of the old setting will be valid.

What alternatives have you considered?
none.

Do you have any additional context?
none.

@tlfeng tlfeng added enhancement New feature or request untriaged upcoming release Don't merge until the version or feature is available v2.0.0 labels Mar 15, 2022
@tlfeng tlfeng changed the title [FEATURE] Document OpenSearch setting change caused by "blacklist / whitelist" nomenclature change [FEATURE] Change the "blacklist / whitelist" nomenclature Mar 15, 2022
@Naarcha-AWS Naarcha-AWS self-assigned this Mar 21, 2022
@Naarcha-AWS Naarcha-AWS added the breaking Involves a breaking change to a release label Mar 23, 2022
@dblock dblock changed the title [FEATURE] Change the "blacklist / whitelist" nomenclature Deprecate the "blacklist / whitelist" nomenclature Apr 18, 2022
@tlfeng tlfeng changed the title Deprecate the "blacklist / whitelist" nomenclature [FEATURE] Deprecate the "blacklist / whitelist" nomenclature Apr 21, 2022
@tlfeng tlfeng changed the title [FEATURE] Deprecate the "blacklist / whitelist" nomenclature [FEATURE] Change the "blacklist / whitelist" nomenclature Apr 22, 2022
@Naarcha-AWS Naarcha-AWS added this to the v2.0.0 milestone May 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Involves a breaking change to a release enhancement New feature or request upcoming release Don't merge until the version or feature is available v2.0.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants