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

Deprecate the "Master" nomenclature #1664

Closed
Tracked by #2589 ...
tlfeng opened this issue Mar 5, 2022 · 8 comments
Closed
Tracked by #2589 ...

Deprecate the "Master" nomenclature #1664

tlfeng opened this issue Mar 5, 2022 · 8 comments
Assignees
Labels
enhancement New feature or request v2.1.0

Comments

@tlfeng
Copy link

tlfeng commented Mar 5, 2022

Is your feature request related to a problem? Please describe.
OpenSearch repository is going to replace the terminology "master"with "cluster manager".
issue: opensearch-project/OpenSearch#472, with the plan for its terminology replacement.

Although the existing usages with "master" will be supported in OpenSearch version 2.x to keep the backwards compatibility, please prepare for the nomenclature change in advance, and replace all the usages with "master" terminology in the code base.
All the OpenSearch REST APIs and settings that contain "master" terminology will be deprecated in 2.0, and alternative usages will be added.

Describe the solution you'd like
Replace the terminology "master" with "cluster manager".

When being compatible with OpenSearch 2.0:

When being compatible with OpenSearch 3.0:

  • Replace "master" in the reference to OpenSearch Java API

Describe alternatives you've considered
None.

Additional context
An existing PR: #1746

@tlfeng tlfeng added the enhancement New feature or request label Mar 5, 2022
@dblock dblock changed the title Change the "Master" nomenclature Deprecate the "Master" nomenclature Apr 18, 2022
@dblock dblock added the v2.0.0 label Apr 18, 2022
@dblock
Copy link
Member

dblock commented Apr 18, 2022

For 2.0, at a minimum please ensure that the plugin is not calling any deprecated APIs in core or another plugin, and confirm below, then remove the 2.0.0 label. If you have time, do the complete deprecation as described in this issue.

@peternied
Copy link
Member

There is an issue in security plugin opensearch-project/security#1746 that we are considering to merge post code freeze. There has been a setting that was renamed as part of inclusive naming in opensearch core which is used in security plugin scripts.
Pros: New inclusive terms usage is in alignment within our release, its a focused change that is validated by CI checks before entering the distribution build. There is a minimal risk of destabilizing perf/stress tests in progress
Cons: Additional inclusive terminology changes are not in for security plugin, and has no outward facing impact making it a good candidate for the next patch release.

[Recapping offline conversation] While this change would be valuable, it does not meet the requirements for the 2.0.0-rc1 release. There are concerns about modifying the setup scripts late in the process. We will add this to the next release.

From opensearch-project/opensearch-build#1624 (comment)

@peternied
Copy link
Member

Before we close this lets add a checkstyle rule to look for this terminology and error if it is detected

@cliu123 cliu123 self-assigned this Jun 13, 2022
@cliu123
Copy link
Member

cliu123 commented Jun 14, 2022

No more action items for this issue.

@cliu123 cliu123 closed this as completed Jun 14, 2022
@peternied
Copy link
Member

peternied commented Jun 14, 2022

Searching for 'master' in our codebase has 26 results. Lets see if we can get that to zero, that checkstyle rule hasn't been enabled, we should turn it on and also drive that count to zero.

@peternied peternied reopened this Jun 14, 2022
@cliu123 cliu123 mentioned this issue Jun 14, 2022
1 task
@cliu123
Copy link
Member

cliu123 commented Jun 16, 2022

There are multiple APIs in OpenSearch core still have master terminology, so security plugin cannot remove all of them: node.master, ClusterChangedEvent.localNodeMaster(), org.opensearch.action.support.master, MasterNodeOperationRequestBuilder.

@tlfeng
Copy link
Author

tlfeng commented Jun 16, 2022

Hey @cliu123, thanks for pointing out. I'm trying deprecating all the Java APIs (public class, method, variable) with "master" terminology, and providing the alternative usage with "cluster manager" in OpenSearch 2.1 by the issue opensearch-project/OpenSearch#1684.
I will update the description in the issue to ask for using the alternative Java APIs in a further 2.x version.

@cliu123
Copy link
Member

cliu123 commented Jun 16, 2022

@tlfeng Thanks for clarifying! We'll close this issue once #1886 is merged as the scope of this issue has been done with the PR. When the Java API and other terminologies are deprecated, please open a separate issue.

@cliu123 cliu123 closed this as completed Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v2.1.0
Projects
None yet
Development

No branches or pull requests

5 participants