[Meta] Deprecate non-inclusive naming

[anasalkouz]

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:

• Change the "Master" nomenclature #472

  • Deprecate the "Master" nomenclature alerting#320
  • Deprecate the "Master" nomenclature anomaly-detection#397
  • Deprecate the "Master" nomenclature index-management#285
  • Deprecate the "Master" nomenclature OpenSearch-Dashboards#1318
  • Deprecate the "Master" nomenclature k-NN#307
  • Change the "Master" nomenclature sql#463
  • Change the "Master" nomenclature asynchronous-search#99
  • Change the "Master" nomenclature  cross-cluster-replication#319
  • Deprecate the "Master" nomenclature performance-analyzer#152
  • Deprecate the "Master" nomenclature performance-analyzer-rca#139
  • Deprecate the "Master" nomenclature security#1664
  • Deprecate the "Master" nomenclature anomaly-detection-dashboards-plugin#235
  • [FEATURE] Change the "master" nomenclature documentation-website#450

• Change the "Blacklist / Whitelist" nomenclature #1483

  • Deprecate the "Blacklist / Whitelist" nomenclature OpenSearch-Dashboards#1319
  • Change the "Blacklist / Whitelist" nomenclature sql#464
  • [FEATURE] Change the "blacklist / whitelist" nomenclature documentation-website#449
  • Deprecate the "Blacklist / Whitelist" nomenclature security#1665
  • Change the "Blacklist / Whitelist" nomenclature alerting#321

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.

[stockholmux]

I'm glad to see this!

[dblock]

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.