Skip to content

Add support for a ForkJoinPool type - 18674 #11023

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
Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Add support for a ForkJoinPool type - 18674 #11023

wants to merge 11 commits into from
+22 −0

Conversation

srikanthpadakanti
Copy link
Contributor

Description

This PR updates the documentation to include information about the new ForkJoinPool thread pool type in OpenSearch. It explains the purpose, configuration options, and use cases for ForkJoinPool, which is now supported as a thread pool type for components that benefit from parallelism, such as jVector.

Issues Resolved

Closes #18664
Closes opensearch-project/OpenSearch#18674

Version

Applies to OpenSearch version 3.2 and later.

Frontend features

N/A (documentation only)

Checklist

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

Add support for a ForkJoinPool type - 18674
84fca6d 
Signed-off-by: Srikanth Padakanti <srikanth_padakanti@apple.com>
@github-actions GitHub Actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@srikanthpadakanti srikanthpadakanti mentioned this pull request Sep 23, 2025
Open
3 tasks
Add support for a ForkJoinPool type - 18674
830ee75 
Signed-off-by: Srikanth Padakanti <srikanth_padakanti@apple.com>
@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress backport 3.2 labels Sep 24, 2025
kolchfa-aws
kolchfa-aws reviewed Sep 24, 2025
View reviewed changes
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @srikanthpadakanti! Please see my comments and let me know if you have any questions.

_install-and-configure/configuring-opensearch/thread-pool-settings.md Outdated

ForkJoin thread pools support the following settings:

- `thread_pool.<pool_name>.parallelism` (Static, integer): Sets the target parallelism level (number of worker threads) for the pool. This typically matches the number of available processors but can be tuned for specific workloads.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do any of these settings have defaults? If so, please list the defaults in the form "Default is <>".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes non zero. Minimum has to be 1. Thanks.

@kolchfa-aws
Copy link
Collaborator

@srikanthpadakanti Just checking in on this PR - could you update it so we can move it forward?

@srikanthpadakanti
Copy link
Contributor Author

srikanthpadakanti commented Oct 6, 2025 •
edited
Loading

Hello @kolchfa-aws Apologies for the delayed response.
There were some PR comments that needs to be addressed. Also, it is already past the 3.3 freeze time. So this has to be going in to 3.4
Once I have enough information, I will make necessary changes to this PR.
Till then, this is on hold.

srikanthpadakanti and others added 7 commits October 6, 2025 11:03
@srikanthpadakanti @kolchfa-aws
Update _install-and-configure/configuring-opensearch/thread-pool-sett…
09e8a5b 
…ings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Srikanth Padakanti <srikanth29.9@gmail.com>
@srikanthpadakanti @kolchfa-aws
Update _install-and-configure/configuring-opensearch/thread-pool-sett…
b17e1b5 
…ings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Srikanth Padakanti <srikanth29.9@gmail.com>
@srikanthpadakanti @kolchfa-aws
Update _install-and-configure/configuring-opensearch/thread-pool-sett…
83446dc 
…ings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Srikanth Padakanti <srikanth29.9@gmail.com>
@srikanthpadakanti @kolchfa-aws
Update _install-and-configure/configuring-opensearch/thread-pool-sett…
a697730 
…ings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Srikanth Padakanti <srikanth29.9@gmail.com>
@srikanthpadakanti @kolchfa-aws
Update _install-and-configure/configuring-opensearch/thread-pool-sett…
833f684 
…ings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Srikanth Padakanti <srikanth29.9@gmail.com>
@srikanthpadakanti @kolchfa-aws
Update _install-and-configure/configuring-opensearch/thread-pool-sett…
63dfec7 
…ings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Srikanth Padakanti <srikanth29.9@gmail.com>
@srikanthpadakanti @kolchfa-aws
Update _install-and-configure/configuring-opensearch/thread-pool-sett…
b6cf414 
…ings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Srikanth Padakanti <srikanth29.9@gmail.com>
@kolchfa-aws kolchfa-aws added v3.4.0 and removed backport 3.2 Doc review PR: Doc review in progress Awaiting response labels Oct 6, 2025
Bukhtawar
Bukhtawar reviewed Oct 8, 2025
View reviewed changes
Copy link
Contributor

@Bukhtawar Bukhtawar left a comment

Choose a reason for hiding this comment

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

Thanks for the changes LGTM

@srikanthpadakanti
Copy link
Contributor Author

Thanks for the changes LGTM

Thank you @Bukhtawar and @kolchfa-aws
You can please go ahead with Merging. Thanks.

@kolchfa-aws
Copy link
Collaborator

Thanks! Moving to editorial review.

@kolchfa-aws
Copy link
Collaborator

@srikanthpadakanti Did this feature make it to 3.3?

@kolchfa-aws kolchfa-aws added the Editorial review PR: Editorial review in progress label Oct 9, 2025
@natebower @kolchfa-aws
Update _install-and-configure/configuring-opensearch/thread-pool-sett…
257fb55 
…ings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Nathan Bower <nbower@amazon.com>
natebower
natebower approved these changes Oct 9, 2025
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

@natebower natebower added Done but waiting to merge PR: The work is done and ready to merge Awaiting response and removed Editorial review PR: Editorial review in progress labels Oct 9, 2025
@srikanthpadakanti
Copy link
Contributor Author

@srikanthpadakanti Did this feature make it to 3.3?

@kolchfa-aws Making it to 3.4.0
PR not merged yet. Thanks.

@natebower natebower removed their assignment Oct 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kolchfa-aws kolchfa-aws kolchfa-aws left review comments

@natebower natebower natebower approved these changes

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

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

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

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

+1 more reviewer

@Bukhtawar Bukhtawar Bukhtawar left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@kolchfa-aws kolchfa-aws

Labels
Done but waiting to merge PR: The work is done and ready to merge v3.4.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feature Request] Add support for a ForkJoinPool type
4 participants
@srikanthpadakanti @kolchfa-aws @Bukhtawar @natebower