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

Add alternative usage for the configuration that contains "blacklist/whitelist" terminology #1547

Closed
tlfeng opened this issue Nov 15, 2021 · 0 comments · Fixed by #2221
Closed
Labels
>breaking Identifies a breaking change. enhancement Enhancement or improvement to existing feature or request v2.0.0 Version 2.0.0

Comments

@tlfeng
Copy link
Collaborator

tlfeng commented Nov 15, 2021

Is your feature request related to a problem? Please describe.
Replace "blacklist/whitelist" terminology in configurations, where the backwards compatibility will be impacted.

A part of #1483

Describe the solution you'd like

  1. Replace the old usages that having "blacklist/whitelist" in configurations with "denylist/allowlist", then create duplicate usages with the old terminology for backwards compatibility (including fallback logic to fallback to settings with the new name).
  2. Add tests to check both old and new usages of the configurations.
  3. Add proper deprecation notice to the old usages.

Describe alternatives you've considered
None.

Additional context
Locations of "blacklist/whitelist" in APIs and configurations:
Settings
1 reindex.remote.whitelist
Code: https://github.com/opensearch-project/OpenSearch/blob/1.0.0/modules/reindex/src/main/java/org/opensearch/index/reindex/TransportReindexAction.java#L60

The guide for plugins can be a reference: https://github.com/opensearch-project/opensearch-plugins/blob/ece53bf9e93403272726eb6087ed98f9c821502b/UPGRADING.md#settings

@tlfeng tlfeng added enhancement Enhancement or improvement to existing feature or request untriaged labels Nov 15, 2021
@tlfeng tlfeng added >breaking Identifies a breaking change. and removed untriaged >breaking Identifies a breaking change. labels Nov 15, 2021
@tlfeng tlfeng changed the title Replace "blacklist/whitelist" terminology in APIs and configurations Add duplicate APIs and configurations that contain "blacklist/whitelist" terminology Nov 16, 2021
@tlfeng tlfeng changed the title Add duplicate APIs and configurations that contain "blacklist/whitelist" terminology Add duplicate configurations that contain "blacklist/whitelist" terminology Dec 9, 2021
@tlfeng tlfeng changed the title Add duplicate configurations that contain "blacklist/whitelist" terminology Add duplicate usage for the configuration that contains "blacklist/whitelist" terminology Feb 25, 2022
@tlfeng tlfeng changed the title Add duplicate usage for the configuration that contains "blacklist/whitelist" terminology Add alternative usage for the configuration that contains "blacklist/whitelist" terminology Mar 4, 2022
@tlfeng tlfeng added the v2.0.0 Version 2.0.0 label Mar 8, 2022
@saratvemulapalli saratvemulapalli added the >breaking Identifies a breaking change. label Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>breaking Identifies a breaking change. enhancement Enhancement or improvement to existing feature or request v2.0.0 Version 2.0.0
Projects
None yet
2 participants