Skip to content

feat: add index.search.default_pipeline setting#7103

Merged
hdhalter merged 2 commits into
opensearch-project:mainfrom
IanMenendez:search-default_pipeline-setting
May 8, 2024
Merged

feat: add index.search.default_pipeline setting#7103
hdhalter merged 2 commits into
opensearch-project:mainfrom
IanMenendez:search-default_pipeline-setting

Conversation

@IanMenendez
Copy link
Copy Markdown
Contributor

@IanMenendez IanMenendez commented May 6, 2024

Description

Add Information on index.search.default_pipeline under _install-and-configure/configuring-opensearch/index-settings.md

Issues Resolved

Closes #7102

Checklist

  • 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.

Signed-off-by: Ian Menendez <ianfmenendezd@gmail.com>
@hdhalter hdhalter added Tech review PR: Tech review in progress backport 2.13 PR: Backport label for 2.13 labels May 6, 2024
@hdhalter
Copy link
Copy Markdown
Contributor

hdhalter commented May 6, 2024

Thanks for adding this, @IanMenendez ! @msfroh - Can you please check this for technical accuracy?

Comment on lines +146 to +147
- `index.search.default_pipeline` (String): The default search pipeline for the index to be used on each search request. If the default pipeline is set and the pipeline does not exist, then index requests fail. The pipeline name _none specifies that the index does not have an search pipeline.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We may want to incorporate the changes (and the limitations) from https://github.com/opensearch-project/documentation-website/pull/7053/files too.

Prior to OpenSearch 2.14, index.search.default_pipeline would only work if you search exactly 1 index using its name. If you tried to us an index pattern, an alias, or multiple indices, then no default pipeline would be applied.

With the linked change, we resolve index names, aliases, patterns to the real indices, check to see which default search pipelines they use (if any). If all resolved indices use the same pipeline, we'll use it. Otherwise, we still won't apply a search pipeline.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, @msfroh, I just relabeled #7053 for 2.14.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

How about we link to the updated topic in https://opensearch.org/docs/latest/search-plugins/search-pipelines/using-search-pipeline/#default-search-pipeline once 2.14 is merged?

I like this idea. As this new changes will make the text way more lengthy

@hdhalter hdhalter added v2.14.0 Doc review PR: Doc review in progress and removed backport 2.13 PR: Backport label for 2.13 Tech review PR: Tech review in progress labels May 6, 2024
Copy link
Copy Markdown
Contributor

@hdhalter hdhalter left a comment

Choose a reason for hiding this comment

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

@msfroh - Can you please review my rewrite? If we are only pointing to the section, we could actually publish this change anytime without waiting for 2.14.

Comment thread _install-and-configure/configuring-opensearch/index-settings.md Outdated
@hdhalter hdhalter self-assigned this May 6, 2024
@hdhalter hdhalter added backport 2.13 PR: Backport label for 2.13 and removed v2.14.0 labels May 8, 2024
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
@hdhalter hdhalter merged commit d065bd5 into opensearch-project:main May 8, 2024
@hdhalter hdhalter added 3 - Done and removed Doc review PR: Doc review in progress labels May 8, 2024
opensearch-trigger-bot Bot pushed a commit that referenced this pull request May 8, 2024
* feat: add index.search.default_pipeline setting

Signed-off-by: Ian Menendez <ianfmenendezd@gmail.com>

* Update _install-and-configure/configuring-opensearch/index-settings.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Ian Menendez <ianfmenendezd@gmail.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
(cherry picked from commit d065bd5)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.13 PR: Backport label for 2.13

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] add index.search.default_pipeline setting

4 participants