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.

Sign up for GitHub

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

Jump to bottom

Use _list/indices API instead of _cat/index API in CatIndexTool #3243

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Use _list/indices API instead of _cat/index API in CatIndexTool #3243

wants to merge 7 commits into from

Conversation

zane-neo
Copy link
Collaborator

@zane-neo zane-neo commented Nov 29, 2024 •
edited
Loading

Description

Use _list/indices API instead of _cat/index API in CatIndexTool

Related Issues

#3182

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • Public documentation issue/PR created.

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.

@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env November 29, 2024 02:03 — with GitHub Actions Inactive
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env November 29, 2024 02:12 — with GitHub Actions Inactive
@zane-neo zane-neo requested a review from dbwiddis December 3, 2024 06:34
@zane-neo zane-neo had a problem deploying to ml-commons-cicd-env December 3, 2024 06:36 — with GitHub Actions Failure
dbwiddis
dbwiddis reviewed Dec 3, 2024
View reviewed changes
Copy link
Member

@dbwiddis dbwiddis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see where we're properly testing the pagination here.

plugin/src/test/java/org/opensearch/ml/tools/CatIndexToolIT.java Outdated Show resolved Hide resolved
plugin/src/test/java/org/opensearch/ml/tools/CatIndexToolIT.java Outdated Show resolved Hide resolved
plugin/src/test/java/org/opensearch/ml/tools/CatIndexToolIT.java Outdated Show resolved Hide resolved
plugin/src/test/java/org/opensearch/ml/tools/CatIndexToolIT.java Outdated Show resolved Hide resolved
plugin/src/test/java/org/opensearch/ml/tools/CatIndexToolIT.java Outdated Show resolved Hide resolved
ml-algorithms/src/main/java/org/opensearch/ml/engine/tools/CatIndexTool.java Outdated Show resolved Hide resolved
ml-algorithms/src/main/java/org/opensearch/ml/engine/tools/CatIndexTool.java Outdated Show resolved Hide resolved
@zane-neo zane-neo had a problem deploying to ml-commons-cicd-env December 4, 2024 07:23 — with GitHub Actions Failure
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 4, 2024 07:23 — with GitHub Actions Inactive
@zane-neo zane-neo force-pushed the migrate-cat-index-tool branch from 580e3ba to ef75795 Compare December 4, 2024 07:52
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 4, 2024 07:53 — with GitHub Actions Inactive
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 4, 2024 07:53 — with GitHub Actions Inactive
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 4, 2024 08:51 — with GitHub Actions Inactive
@ylwu-amzn
Copy link
Collaborator

Add a comment on the issue #3182 (comment)

Why not build another ListIndexTool?
List index API introduced in 2.18 https://opensearch.org/docs/latest/api-reference/list/list-indices/. Seems hard to backport fix/enhance of CatIndexTool to older versions by changing it to _list/indices ,

Any thoughts, @zane-neo , @dbwiddis ?

@dbwiddis
Copy link
Member

dbwiddis commented Dec 4, 2024

Any thoughts, @zane-neo , @dbwiddis ?

Agreed a new tool would be cleaner. RestIndicesListAction extends RestIndicesAction (that Cat Index uses) so it'd be better to logically extend the other tool with just the updated parameters.

@zane-neo zane-neo had a problem deploying to ml-commons-cicd-env December 5, 2024 00:55 — with GitHub Actions Failure
@zane-neo zane-neo had a problem deploying to ml-commons-cicd-env December 5, 2024 00:55 — with GitHub Actions Failure
@zane-neo zane-neo had a problem deploying to ml-commons-cicd-env December 5, 2024 00:58 — with GitHub Actions Failure
@zane-neo zane-neo had a problem deploying to ml-commons-cicd-env December 5, 2024 00:58 — with GitHub Actions Failure
@zane-neo
fix failure IT
99b3130 
Signed-off-by: zane-neo <[email protected]>
@zane-neo zane-neo had a problem deploying to ml-commons-cicd-env December 5, 2024 01:48 — with GitHub Actions Failure
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 5, 2024 01:48 — with GitHub Actions Inactive
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 5, 2024 02:46 — with GitHub Actions Inactive
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 5, 2024 07:10 — with GitHub Actions Inactive
@zane-neo
Copy link
Collaborator Author

zane-neo commented Dec 9, 2024

@dbwiddis @ylwu-amzn @dhrubo-os I've addressed your comments, can you review and approve? Thanks.

dbwiddis
dbwiddis approved these changes Dec 9, 2024
View reviewed changes
Copy link
Member

@dbwiddis dbwiddis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a minor point on comment clarity!

ml-algorithms/src/main/java/org/opensearch/ml/engine/tools/ListIndexTool.java Outdated Show resolved Hide resolved
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 10, 2024 01:20 — with GitHub Actions Inactive
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 10, 2024 05:52 — with GitHub Actions Inactive
@zane-neo zane-neo temporarily deployed to ml-commons-cicd-env December 10, 2024 06:50 — with GitHub Actions Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dbwiddis dbwiddis dbwiddis approved these changes

@b4sjoo b4sjoo Awaiting requested review from b4sjoo b4sjoo is a code owner

@dhrubo-os dhrubo-os Awaiting requested review from dhrubo-os dhrubo-os is a code owner

@jngz-es jngz-es Awaiting requested review from jngz-es jngz-es is a code owner

@model-collapse model-collapse Awaiting requested review from model-collapse model-collapse is a code owner

@rbhavna rbhavna Awaiting requested review from rbhavna rbhavna is a code owner

@ylwu-amzn ylwu-amzn Awaiting requested review from ylwu-amzn ylwu-amzn is a code owner

@Zhangxunmt Zhangxunmt Awaiting requested review from Zhangxunmt Zhangxunmt is a code owner

@austintlee austintlee Awaiting requested review from austintlee austintlee is a code owner

@HenryL27 HenryL27 Awaiting requested review from HenryL27 HenryL27 is a code owner

@xinyual xinyual Awaiting requested review from xinyual xinyual is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@zane-neo @ylwu-amzn @dbwiddis