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

tlfeng · 2022-03-30T06:42:51Z

Description

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 Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index Template APIs #2678)
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-30T07:14:17Z

❌ Gradle Check failure 6fa9c04
Log 3892

Reports 3892

nknize

Same change request as in #2658

server/src/main/java/org/opensearch/rest/action/admin/indices/RestCloseIndexAction.java

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

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

❌ Gradle Check failure befebfe
Log 3931

Reports 3931

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

❌ Gradle Check failure 95c64a3
Log 3933

Reports 3933

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

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

❌ Gradle Check failure a69879f
Log 3937

Reports 3937

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

opensearch-ci-bot · 2022-03-30T23:10:39Z

❌ Gradle Check failure 5bfd22b
Log 3938

Reports 3938

opensearch-ci-bot · 2022-03-30T23:23:29Z

❌ Gradle Check failure 80c91153c1a7af82725aec558ad1aa19b19b8243
Log 3939

Reports 3939

opensearch-ci-bot · 2022-03-30T23:27:32Z

❌ Gradle Check failure b892805
Log 3940

Reports 3940

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

opensearch-ci-bot · 2022-03-31T00:03:02Z

❌ Gradle Check failure 4ac10f6
Log 3942

Reports 3942

nknize

Oh yeah.. this is much cleaner!!! Nice work.

rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json

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

opensearch-ci-bot · 2022-04-05T04:57:25Z

❌ Gradle Check failure e085e53
Log 4185

Reports 4185

nknize · 2022-04-05T05:15:08Z

#1703 strikes again!

nknize · 2022-04-05T05:15:18Z

start gradle check

opensearch-ci-bot · 2022-04-05T05:44:44Z

❌ Gradle Check failure e085e53
Log 4188

Reports 4188

tlfeng · 2022-04-05T06:18:25Z

In log 4188:

* What went wrong:
Execution failed for task ':modules:analysis-common:test'.
> Process 'Gradle Test Executor 446' finished with non-zero exit value 1
  This problem might be caused by incorrect test process configuration.
  Please refer to the test execution section in the User Manual at https://docs.gradle.org/7.4.2/userguide/java_testing.html#sec:test_execution

start gradle check

opensearch-ci-bot · 2022-04-05T06:56:18Z

✅ Gradle Check success e085e53
Log 4191

Reports 4191

…_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)

…_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)

…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]>

…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 3 commits March 29, 2022 21:05

Deprecate master_timeout parameter in 3 index API

fde3e3d

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

Deprecate master_timeout parameter in half of index APIs

938f52b

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

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

6fa9c04

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

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

nknize requested changes Mar 30, 2022

View reviewed changes

server/src/main/java/org/opensearch/rest/action/admin/indices/RestCloseIndexAction.java Outdated Show resolved Hide resolved

Tianli Feng added 2 commits March 30, 2022 15:08

Deprecate master_timeout parameter in half of index APIs

befebfe

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

Adjust format by spotlessApply task

95c64a3

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

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

Revert index template API changes

a69879f

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

Revert index template API changes

5bfd22b

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

tlfeng force-pushed the manager-timeout-index-api branch from 2a50055 to 5bfd22b Compare March 30, 2022 22:41

tlfeng changed the title ~~Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index APIs - part 1~~ Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in half of Index APIs (without index template APIs) Mar 30, 2022

Deprecate master_timeout parameter in rest-api-spec

b892805

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

tlfeng force-pushed the manager-timeout-index-api branch from 80c9115 to b892805 Compare March 30, 2022 23:06

Add allowed warnings for yaml rest test that using master_timeout

4ac10f6

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

tlfeng changed the title ~~Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in half of Index APIs (except index template APIs)~~ Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index APIs except index template APIs Mar 31, 2022

tlfeng mentioned this pull request Mar 31, 2022

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

Merged

5 tasks

This was referenced Apr 4, 2022

[CI] tasks.list/10_basic/tasks_list test failure #2757

Closed

Replace blacklist in Gradle build environment configuration #2752

Merged

nknize self-requested a review April 5, 2022 04:12

nknize approved these changes Apr 5, 2022

View reviewed changes

tlfeng commented Apr 5, 2022

View reviewed changes

rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json Outdated Show resolved Hide resolved

Tianli Feng added 2 commits April 4, 2022 21:22

Deprecate master_timeout parameter in get template API spec

b914741

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

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

e085e53

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

tlfeng merged commit 7aa496f into opensearch-project:main Apr 5, 2022

tlfeng deleted the manager-timeout-index-api branch April 5, 2022 17:47

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

[Backport 2.x] Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index APIs except index template APIs #2770

Merged

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

[Backport 2.0] Add request parameter 'cluster_manager_timeout' and deprecate 'master_timeout' - in Index APIs except index template APIs #2771

Merged

tlfeng mentioned this pull request Apr 12, 2022

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

Closed

andrross mentioned this pull request Nov 14, 2022

[BUG] Gradle check retry not working as expected #5239

Closed

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 APIs except index template APIs #2660

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

tlfeng commented Mar 30, 2022 •

edited

Loading

opensearch-ci-bot commented Mar 30, 2022

nknize left a comment

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 30, 2022

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 31, 2022

nknize left a comment

opensearch-ci-bot commented Apr 5, 2022

nknize commented Apr 5, 2022

nknize commented Apr 5, 2022

opensearch-ci-bot commented Apr 5, 2022

tlfeng commented Apr 5, 2022

opensearch-ci-bot commented Apr 5, 2022

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

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

Conversation

tlfeng commented Mar 30, 2022 • edited Loading

Description

Issues Resolved

Check List

opensearch-ci-bot commented Mar 30, 2022

nknize left a comment

Choose a reason for hiding this comment

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 30, 2022

opensearch-ci-bot commented Mar 30, 2022

opensearch-ci-bot commented Mar 31, 2022

nknize left a comment

Choose a reason for hiding this comment

opensearch-ci-bot commented Apr 5, 2022

nknize commented Apr 5, 2022

nknize commented Apr 5, 2022

opensearch-ci-bot commented Apr 5, 2022

tlfeng commented Apr 5, 2022

opensearch-ci-bot commented Apr 5, 2022

tlfeng commented Mar 30, 2022 •

edited

Loading