Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2678

tlfeng · 2022-03-30T22:17:28Z

Description

Deprecate the request parameter master_timeout that used in Index Template APIs which have got the parameter.
(The other Index APIs are addressed in PR Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index APIs except index template APIs #2660)
Add alternative new request parameter cluster_manager_timeout.
Add unit tests.

List of the Index APIs that have got request parameter master_timeout:

Index management:
Create index API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/
Delete index API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/delete-index/
Get index API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/get-index/
Open index API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/open-index/
Close index API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
Clone index API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/clone/
Shrink index API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/shrink-index/
Split index API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/split/
Rollover index API POST /<rollover-target>/_rollover/<target-index>
Alias management:
Add index alias API https://opensearch.org/docs/latest/opensearch/rest-api/alias/
Delete index alias API DELETE /<index>/_alias/<alias>
Mapping management:
Get mapping API
Put mapping API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/put-mapping/
Index settings:
Get Index Settings API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/get-settings/
Update index settings API https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/update-settings/
Index templates:
Get (Legacy) Index Template API GET /_template/<index-template>
Delete (Legacy) Index Template API DELETE /_template/<index-template>
Put (Legacy) Index Template API PUT /_template/<index-template>
Get (Composable) Index Template API GET /_index_template/<index-template>
Delete (Composable) Index Template API
Put (Composable) Index Template API
Get Component Template API GET /_component_template/<index-template>
Delete Component Template API
Put Component Template API
Simulate index API POST /_index_template/_simulate_index/{name}
Simulate index template API POST /_index_template/_simulate
Dangling indices:
Delete Dangling Index API
Import Dangling Index API POST /_dangling/<index-uuid>
Other:
Add index block API PUT /<index>/_block/<block>

Issues Resolved

A part of issue #2511

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-03-30T22:40:50Z

❌ Gradle Check failure 3084306
Log 3934

Reports 3934

opensearch-ci-bot · 2022-03-30T23:00:00Z

❌ Gradle Check failure 16f92a4
Log 3935

Reports 3935

opensearch-ci-bot · 2022-03-30T23:01:11Z

❌ Gradle Check failure 38ea9f4
Log 3936

Reports 3936

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-03-30T23:41:56Z

❌ Gradle Check failure d40f0bb
Log 3941

Reports 3941

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-03-31T00:05:11Z

❌ Gradle Check failure 49e5b55
Log 3943

Reports 3943

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/main/java/org/opensearch/rest/BaseRestHandler.java

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-04-01T08:00:32Z

❌ Gradle Check failure 7dc0693caa74aff36db9f226c74c5b4d3b3e7a57
Log 4020

Reports 4020

opensearch-ci-bot · 2022-04-01T08:19:22Z

❌ Gradle Check failure 45682e6
Log 4021

Reports 4021

tlfeng · 2022-04-01T08:22:40Z

In log 4021:

> Task :client:rest-high-level:asyncIntegTest

REPRODUCE WITH: ./gradlew ':client:rest-high-level:asyncIntegTest' --tests "org.opensearch.client.ClusterClientIT.testComponentTemplates" -Dtests.seed=5D619C52A4F49DBD -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=mt -Dtests.timezone=America/Kentucky/Monticello -Druntime.java=17

org.opensearch.client.ClusterClientIT > testComponentTemplates FAILED
    org.opensearch.client.WarningFailureException: method [PUT], host [http://127.0.0.1:36197], URI [/_component_template/my-template?master_timeout=30s&create=true], status line [HTTP/1.1 200 OK]
    Warnings: [Deprecated parameter [master_timeout] used. To promote inclusive language, please use [cluster_manager_timeout] instead. It will be unsupported in a future major version.]
    {"acknowledged":true}
        at __randomizedtesting.SeedInfo.seed([5D619C52A4F49DBD:E05E505372FADD32]:0)
        at app//org.opensearch.client.RestClient.convertResponse(RestClient.java:346)

I will mute those HLRC tests temporarily until PR #2683 is merged.

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/test/java/org/opensearch/action/RenamedTimeoutRequestParameterTests.java

…_timeout' - in Index APIs except index template APIs (#2660) - Deprecate the request parameter `master_timeout` that used in Index APIs which have got the parameter. (except index template APIs, which is addressed in PR #2678) - Add alternative new request parameter `cluster_manager_timeout`. - Add unit tests. Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit 7aa496f)

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/test/java/org/opensearch/action/RenamedTimeoutRequestParameterTests.java

opensearch-ci-bot · 2022-04-05T18:40:35Z

✅ Gradle Check success 254b8a32311b383eae5203e17e746f3f2c7df0be
Log 4207

Reports 4207

opensearch-ci-bot · 2022-04-05T18:45:51Z

✅ Gradle Check success 2be523a
Log 4208

Reports 4208

…_timeout' - in Index APIs except index template APIs (#2660) (#2770) - Deprecate the request parameter `master_timeout` that used in Index APIs which have got the parameter. (except index template APIs, which is addressed in PR #2678) - Add alternative new request parameter `cluster_manager_timeout`. - Add unit tests. Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit 7aa496f)

…_timeout' - in Index APIs except index template APIs (#2660) (#2771) - Deprecate the request parameter `master_timeout` that used in Index APIs which have got the parameter. (except index template APIs, which is addressed in PR #2678) - Add alternative new request parameter `cluster_manager_timeout`. - Add unit tests. Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit 7aa496f)

anasalkouz · 2022-04-11T18:55:29Z

rest-api-spec/src/main/resources/rest-api-spec/test/indices.exists_template/10_basic.yml

@@ -23,6 +25,8 @@ setup:
            number_of_replicas: 0

  - do:
+      allowed_warnings:
+        - "Deprecated parameter [master_timeout] used. To promote inclusive language, please use [cluster_manager_timeout] instead. It will be unsupported in a future major version."


in the next major version 3.0

@anasalkouz Thanks for this idea. My concern is once the deprecated parameter can not be removed in version 3.0, the warning message will become inaccurate.
I'm just worrying about there will be resistance of the old usage removal from the users, which make the removal postponed.
If you think it's better to specify the version number in the warning message, I will change it to It will be removed in 3.0.
The message is defined in this file, I will create a separate PR to change it.

Changed the deprecation message in a separate PR #2863 . I will update this PR accordingly once that is merged. 😁

Changed the deprecation message in YAML rest api test in commit 07fc06d 👍

…ex-api-part2 Signed-off-by: Tianli Feng <[email protected]>

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-04-11T22:17:11Z

✅ Gradle Check success b052308
Log 4380

Reports 4380

…ex-api-part2 Signed-off-by: Tianli Feng <[email protected]>

…pi yaml test Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-04-11T23:48:35Z

✅ Gradle Check success 07fc06d
Log 4386

Reports 4386

…r_timeout' - in Index Template APIs (#2678) - Deprecate the request parameter `master_timeout` that used in Index Template APIs which have got the parameter. (The other Index APIs are addressed in PR #2660) - Add alternative new request parameter `cluster_manager_timeout`. - Add unit tests. Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit ba3ed8a)

…r_timeout' - in Index Template APIs (#2678) (#2866) - Deprecate the request parameter `master_timeout` that used in Index Template APIs which have got the parameter. (The other Index APIs are addressed in PR #2660) - Add alternative new request parameter `cluster_manager_timeout`. - Add unit tests. Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit ba3ed8a)

…r_timeout' - in Index Template APIs (#2678) (#2867) - Deprecate the request parameter `master_timeout` that used in Index Template APIs which have got the parameter. (The other Index APIs are addressed in PR #2660) - Add alternative new request parameter `cluster_manager_timeout`. - Add unit tests. Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit ba3ed8a)

Tianli Feng added 4 commits March 30, 2022 15:13

Deprecate master_timeout parameter in half of index APIs

74ad6d3

Signed-off-by: Tianli Feng <[email protected]>

Adjust format by spotlessApply task

3084306

Signed-off-by: Tianli Feng <[email protected]>

Revert some API changes

16f92a4

Signed-off-by: Tianli Feng <[email protected]>

Revert some API changes

38ea9f4

Signed-off-by: Tianli Feng <[email protected]>

tlfeng changed the title ~~Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index template APIs~~ Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs Mar 30, 2022

tlfeng mentioned this pull request Mar 30, 2022

Add a new request parameter "cluster_manager_timeout" in the REST APIs that accept "master_timeout" parameter, and deprecate "master_timeout" #2511

Closed

11 tasks

tlfeng added v2.0.0 Version 2.0.0 backport 2.x Backport to 2.x branch backport 2.0 Backport to 2.0 branch enhancement Enhancement or improvement to existing feature or request labels Mar 30, 2022

Add allowed warnings for yaml rest test that using master_timeout

d40f0bb

Signed-off-by: Tianli Feng <[email protected]>

Add allowed warnings for yaml rest test that using master_timeout

49e5b55

Signed-off-by: Tianli Feng <[email protected]>

tlfeng mentioned this pull request Mar 31, 2022

Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index APIs except index template APIs #2660

Merged

5 tasks

tlfeng added the WIP Work in progress label Mar 31, 2022

Tianli Feng added 2 commits March 31, 2022 22:06

Merge branch 'main' into manager-timeout-index-api-part2

02f6079

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/main/java/org/opensearch/rest/BaseRestHandler.java

Add unit test for Index template APIs

45682e6

Signed-off-by: Tianli Feng <[email protected]>

tlfeng force-pushed the manager-timeout-index-api-part2 branch from 7dc0693 to 45682e6 Compare April 1, 2022 07:47

tlfeng removed the WIP Work in progress label Apr 1, 2022

tlfeng marked this pull request as ready for review April 1, 2022 07:48

tlfeng requested a review from a team as a code owner April 1, 2022 07:48

tlfeng mentioned this pull request Apr 1, 2022

Make High-Level-Rest-Client tests allow deprecation warning temporarily, during deprecation of request parameter 'master_timeout' #2702

Merged

5 tasks

Merge branch 'main' into manager-timeout-index-api-part2

315fa82

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/test/java/org/opensearch/action/RenamedTimeoutRequestParameterTests.java

Merge branch 'main' into manager-timeout-index-api-part2

2be523a

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/test/java/org/opensearch/action/RenamedTimeoutRequestParameterTests.java

tlfeng force-pushed the manager-timeout-index-api-part2 branch from 254b8a3 to 2be523a Compare April 5, 2022 18:10

anasalkouz reviewed Apr 11, 2022

View reviewed changes

Tianli Feng added 2 commits April 11, 2022 14:37

Merge remote-tracking branch 'upstream/main' into manager-timeout-ind…

a31b699

…ex-api-part2 Signed-off-by: Tianli Feng <[email protected]>

Deprecate master_timeout parameter in index template API spec

b052308

Signed-off-by: Tianli Feng <[email protected]>

tlfeng mentioned this pull request Apr 11, 2022

Change deprecation message for REST API parameter 'master_timeout' to specify the version of removal #2863

Merged

5 tasks

Tianli Feng added 2 commits April 11, 2022 16:05

Merge remote-tracking branch 'upstream/main' into manager-timeout-ind…

8890ea9

…ex-api-part2 Signed-off-by: Tianli Feng <[email protected]>

Change deprecation message for API parameter master_timeout in rest a…

07fc06d

…pi yaml test Signed-off-by: Tianli Feng <[email protected]>

mch2 approved these changes Apr 11, 2022

View reviewed changes

tlfeng merged commit ba3ed8a into opensearch-project:main Apr 12, 2022

tlfeng deleted the manager-timeout-index-api-part2 branch April 12, 2022 00:29

opensearch-trigger-bot bot mentioned this pull request Apr 12, 2022

[Backport 2.x] Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2866

Merged

opensearch-trigger-bot bot mentioned this pull request Apr 12, 2022

[Backport 2.0] Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2867

Merged

This was referenced Apr 12, 2022

Added a new line linter #2875

Merged

[BUG] Test failure exists but Gradle 'check' task passes #2878

Closed

Change deprecation message for API parameter value 'master_node' of parameter 'metric' #2880

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2678

Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2678

tlfeng commented Mar 30, 2022 •

edited

Loading

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 31, 2022

opensearch-ci-bot commented Apr 1, 2022

opensearch-ci-bot commented Apr 1, 2022

tlfeng commented Apr 1, 2022

opensearch-ci-bot commented Apr 5, 2022

opensearch-ci-bot commented Apr 5, 2022

anasalkouz Apr 11, 2022

tlfeng Apr 11, 2022 •

edited

Loading

tlfeng Apr 11, 2022 •

edited

Loading

tlfeng Apr 11, 2022

opensearch-ci-bot commented Apr 11, 2022

opensearch-ci-bot commented Apr 11, 2022

Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2678

Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2678

Conversation

tlfeng commented Mar 30, 2022 • edited Loading

Description

Issues Resolved

Check List

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 31, 2022

opensearch-ci-bot commented Apr 1, 2022

opensearch-ci-bot commented Apr 1, 2022

tlfeng commented Apr 1, 2022

opensearch-ci-bot commented Apr 5, 2022

opensearch-ci-bot commented Apr 5, 2022

anasalkouz Apr 11, 2022

Choose a reason for hiding this comment

tlfeng Apr 11, 2022 • edited Loading

Choose a reason for hiding this comment

tlfeng Apr 11, 2022 • edited Loading

Choose a reason for hiding this comment

tlfeng Apr 11, 2022

Choose a reason for hiding this comment

opensearch-ci-bot commented Apr 11, 2022

opensearch-ci-bot commented Apr 11, 2022

tlfeng commented Mar 30, 2022 •

edited

Loading

tlfeng Apr 11, 2022 •

edited

Loading

tlfeng Apr 11, 2022 •

edited

Loading