[Meta] Deprecate non-inclusive naming #2589

anasalkouz · 2022-03-24T20:08:58Z

This is a meta issue to track the pan and progress of applying inclusive naming across OpenSearch Repositories

Timeline

OpenSearch 2.0 will deprecate several APIs in core. Plugins will deprecate APIs in 2.0. By a 2.x version all non-inclusive terminology will be deprecated, and all deprecated APIs will be removed in 3.0.

High Level Plan
Every repository that uses non-inclusive words should replace all the non-inclusive usages in the code base. There are 2 main action to take as following:

We have provided alternative REST APIs/settings for the existing non-inclusive usages for OpenSearch main repository, which means all the REST APIs/settings that contain "master" or "blacklist/whitelist" will have alternative usages that uses "cluster_manager" or "denylist/allowlist". That being said, you should use the new introduced REST APIs/settings in 2.0. Please see here for the inclusive alternative REST APIs/settings.
You should replace non-inclusive usages into your repositories, the following is our suggested plan to follow:
- Replace the non-inclusive words in code comment and internal variable/method/class/package name in 2.0.
- Introduce alternative REST APIs/settings for the existing non-inclusive usages and deprecate old usage in 2.0.
- Replace non-inclusive usages for OpenSearch REST API and setting with provided inclusive ones in 2.0
- Replace non-inclusive usages for OpenSearch Java API and remove all deprecated usages in 3.0.

List of Issues
When being compatible with OpenSearch 2.0:

List of REST APIs and settings that contain non-inclusive name in other repositories
REST API of plugins

Performance Analyzer
Impacted API: GET <endpoint>:9600/_plugins/_performanceanalyzer/metrics
Document: https://opensearch.org/docs/latest/monitoring-plugins/pa/api/
Detail: Names of 3 Performance Analyzer metrics can be contained in an optional parameter of the API request, and a field of the API response: Master_PendingQueueSize , Master_Task_Queue_Time , Master_Task_Run_Time .
Security
Impacted API: GET (or PUT or PATCH) _plugins/_security/api/whitelist
Code: https://github.com/opensearch-project/security/blob/1.2.4.0/src/main/java/org/opensearch/security/dlic/rest/api/WhitelistApiAction.java
Detail: “whitelist” contains in the API endpoint.

Configuration / Setting

OpenSearch Dashboards
Impacted setting names:
opensearch.requestHeadersWhitelist ,
server.compression.referrerWhitelist ,
server.xsrf.whitelist .
Detail: These settings can be configured through opensearch_dahsboards.yml file in config directory.
Security
Impacted configuration file: whitelist.yml
Document: https://www.opensearch.org/docs/1.2/security-plugin/configuration/yaml/#whitelistyml
Detail: It is a YAML file in plugins/opensearch-security/securityconfig directory, configurations defined in the file can be imported to Security plugin.

The text was updated successfully, but these errors were encountered:

stockholmux · 2022-03-25T20:15:13Z

I'm glad to see this!

dblock · 2022-04-18T19:51:49Z

I've updated the timeline: OpenSearch 2.0 will deprecate several APIs in core. Plugins will deprecate APIs in 2.1. By a 2.x version all non-inclusive terminology will be deprecated, and all deprecated APIs will be removed in 3.0. This issue is now only about deprecation.

…Manager As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories Every repository that uses non-inclusive words should replace all the non-inclusive usages in the code base. In this change we are replacing the instances of the terminology "isDevClusterMaster" with "isDevClusterManager". Signed-off-by: manasvis <manasvis@amazon.com>

As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories Every repository that uses non-inclusive words should replace all the non-inclusive usages in the code base. We are deprecating setupMaster in favor of setupClusterManager Signed-off-by: manasvis <manasvis@amazon.com>

…evClusterManager As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories Every repository that uses non-inclusive words should replace all the non-inclusive usages in the code base. In this change we are deprecating the terminology "isDevClusterMaster" and adding "isDevClusterManager" for future usages. Signed-off-by: manasvis <manasvis@amazon.com>

As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories We are deprecating setupMaster in favor of setupClusterManager Signed-off-by: manasvinibs <manasvis@amazon.com>

… nodes (#1761) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories Issue - #1688 Signed-off-by: manasvinibs <manasvis@amazon.com> (cherry picked from commit 6aba08a) Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…meout As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - opensearch-project#1685 Signed-off-by: manasvinibs <manasvis@amazon.com>

…nction names As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - opensearch-project#1692 Signed-off-by: manasvinibs <manasvis@amazon.com>

… nodes (#1761) (#1779) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories Issue - #1688 Signed-off-by: manasvinibs <manasvis@amazon.com> (cherry picked from commit 6aba08a) Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> Co-authored-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…nction names As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - opensearch-project#1692 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…meout As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - opensearch-project#1685 Signed-off-by: manasvinibs <manasvis@amazon.com>

…meout As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - opensearch-project#1685 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…nction names As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - opensearch-project#1692 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…meout As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - opensearch-project#1685 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…nction names (#1778) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - #1692 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…nction names (#1778) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - #1692 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> (cherry picked from commit e32a259)

…meout (#1788) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Includes updates from generation with the removal of type. Issues: #1685 #1290 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…meout (#1788) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Includes updates from generation with the removal of type. Issues: #1685 #1290 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> (cherry picked from commit c659831)

…nction names (#1778) (#1793) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Issue - #1692 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> (cherry picked from commit e32a259) Co-authored-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…meout (#1788) (#1794) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories. Includes updates from generation with the removal of type. Issues: #1685 #1290 Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> (cherry picked from commit c659831) Co-authored-by: Manasvini B Suryanarayana <manasvis@amazon.com>

saratvemulapalli · 2022-06-28T15:48:25Z

@anasalkouz / @tlfeng this issue is tagged 2.1.0.
I know we had revert couple of PRs. Is it safe to assume we will not completely ship in 2.1?

…evClusterManager (opensearch-project#1719) (opensearch-project#1762) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories In this change we are deprecating the terminology "isDevClusterMaster" and adding "isDevClusterManager" for future usages. Signed-off-by: manasvinibs <manasvis@amazon.com> Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> (cherry picked from commit 1dda730) Co-authored-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…pensearch-project#1752) (opensearch-project#1769) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories We are deprecating setupMaster in favor of setupClusterManager Signed-off-by: manasvinibs <manasvis@amazon.com> (cherry picked from commit 9e508e7) Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> Co-authored-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…evClusterManager (opensearch-project#1719) (opensearch-project#1762) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories In this change we are deprecating the terminology "isDevClusterMaster" and adding "isDevClusterManager" for future usages. Signed-off-by: manasvinibs <manasvis@amazon.com> Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> (cherry picked from commit 1dda730) Co-authored-by: Manasvini B Suryanarayana <manasvis@amazon.com>

…pensearch-project#1752) (opensearch-project#1769) As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories We are deprecating setupMaster in favor of setupClusterManager Signed-off-by: manasvinibs <manasvis@amazon.com> (cherry picked from commit 9e508e7) Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com> Co-authored-by: Manasvini B Suryanarayana <manasvis@amazon.com>

anasalkouz added enhancement Enhancement or improvement to existing feature or request untriaged v2.0.0 Version 2.0.0 Meta Meta issue, not directly linked to a PR and removed untriaged labels Mar 24, 2022

anasalkouz mentioned this issue Mar 24, 2022

[RELEASE] Release version 2.0.0 (RC1) opensearch-project/opensearch-build#1624

Closed

51 tasks

anasalkouz changed the title ~~[Meta] The plan to applying inclusive naming~~ [Meta] Applying inclusive naming Mar 24, 2022

tlfeng mentioned this issue Apr 12, 2022

[Documentation] Breaking changes in 2.0 #2480

Closed

10 tasks

dblock added campaign Parent issues of OpenSearch release campaigns. v3.0.0 Issues and PRs related to version 3.0.0 labels Apr 18, 2022

dblock mentioned this issue Apr 18, 2022

[RELEASE] Release version 2.1.0 opensearch-project/opensearch-build#1818

Closed

40 tasks

dblock changed the title ~~[Meta] Applying inclusive naming~~ [Meta] Deprecate non-inclusive naming Apr 18, 2022

dblock added v2.1.0 Issues and PRs related to version 2.1.0 and removed v3.0.0 Issues and PRs related to version 3.0.0 labels Apr 18, 2022

This was referenced Apr 18, 2022

Change the "Master" nomenclature #472

Closed

Deprecate the "Master" nomenclature opensearch-project/OpenSearch-Dashboards#1318

Closed

Change the "Blacklist / Whitelist" nomenclature #1483

Closed

ananzh mentioned this issue Apr 21, 2022

Deprecate the "Master" nomenclature in nodejs client opensearch-project/opensearch-js#221

Closed

kartg removed the v2.0.0 Version 2.0.0 label Apr 28, 2022

peterzhuamazon mentioned this issue May 5, 2022

[RELEASE] Release version 2.0.0 opensearch-project/opensearch-build#2086

Closed

46 tasks

manasvinibs mentioned this issue Jun 10, 2022

[Non-Inclusive Language] Replace isDevClusterMaster with isDevClusterManager opensearch-project/OpenSearch-Dashboards#1719

Merged

7 tasks

cliu123 mentioned this issue Jun 13, 2022

[BUG] on opensearch 2.0.0, securityadmin.sh is still looking for whitelist.yml instead of allowlist.yml opensearch-project/security#1879

Closed

acarbonetto mentioned this issue Jun 14, 2022

Breaking changes for 2.0 opensearch-project/opensearch-net#34

Closed

manasvinibs mentioned this issue Jun 23, 2022

[Deprecation] Deprecate master_timeout in favor of cluster_manager_timeout opensearch-project/OpenSearch-Dashboards#1788

Merged

7 tasks

This was referenced Jun 24, 2022

[Deprecation] Deprecate the apiVersion: master value and replace with main opensearch-project/OpenSearch-Dashboards#1799

Merged

[Deprecation] Deprecate cat master API in favor of cat cluster_manager opensearch-project/OpenSearch-Dashboards#1800

Merged

peterzhuamazon mentioned this issue Jun 27, 2022

Is "master" terminology planned to be deprecated? opensearch-project/helm-charts#276

Open

Rishikesh1159 removed the v2.1.0 Issues and PRs related to version 2.1.0 label Jun 30, 2022

peterzhuamazon mentioned this issue Jul 25, 2022

[RELEASE] Release version 2.2.0 opensearch-project/opensearch-build#2271

Closed

48 tasks

gaiksaya mentioned this issue Sep 1, 2022

[RELEASE] Release version 2.3.0 opensearch-project/opensearch-build#2447

Closed

46 tasks

peterzhuamazon mentioned this issue Sep 29, 2022

[RELEASE] Release version 2.4.0 opensearch-project/opensearch-build#2649

Closed

52 tasks

anasalkouz closed this as completed Dec 8, 2022

JeffHuss mentioned this issue Feb 24, 2023

[DOCS-META] Version upgrade and migration documentation opensearch-project/documentation-website#2830

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Meta] Deprecate non-inclusive naming #2589

[Meta] Deprecate non-inclusive naming #2589

anasalkouz commented Mar 24, 2022 •

edited

Loading

stockholmux commented Mar 25, 2022

dblock commented Apr 18, 2022 •

edited

Loading

saratvemulapalli commented Jun 28, 2022

[Meta] Deprecate non-inclusive naming #2589

[Meta] Deprecate non-inclusive naming #2589

Comments

anasalkouz commented Mar 24, 2022 • edited Loading

stockholmux commented Mar 25, 2022

dblock commented Apr 18, 2022 • edited Loading

saratvemulapalli commented Jun 28, 2022

anasalkouz commented Mar 24, 2022 •

edited

Loading

dblock commented Apr 18, 2022 •

edited

Loading