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.

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

Document new ingest and search pipeline allowlist settings #7414

Merged
merged 8 commits into from
Jul 1, 2024

Conversation

andrross
Copy link
Member

Description

Document new setting being added in opensearch-project/OpenSearch#14439

Version

2.16+

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: Andrew Ross <andrross@amazon.com>
@andrross andrross changed the title Document new ingest.processor.allowlist setting Document new ingest and search pipeline allowlist settings Jun 27, 2024
@andrross andrross marked this pull request as ready for review June 27, 2024 21:33
@vagimeli vagimeli self-assigned this Jun 28, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Copy link
Collaborator

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

Doc review complete. Moving to editorial.

@vagimeli vagimeli added the 5 - Editorial review PR: Editorial review in progress label Jun 28, 2024
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.

@vagimeli @andrross Just a few changes. Thanks!

_ingest-pipelines/processors/index-processors.md Outdated Show resolved Hide resolved
_search-plugins/search-pipelines/search-processors.md Outdated Show resolved Hide resolved

## Selectively enabling processors

Processors defined by the [search-pipeline-common module](https://github.com/opensearch-project/OpenSearch/blob/2.x/modules/search-pipeline-common/src/main/java/org/opensearch/search/pipeline/common/SearchPipelineCommonModulePlugin.java) are selectively enabled through the following cluster settings: `search.pipeline.common.request.processors.allowed`, `search.pipeline.common.response.processors.allowed`, or `search.pipeline.common.search.phase.results.processors.allowed`. If unspecified, all processors are enabled. An empty list disables all. Removing enabled processors causes pipelines using them to fail after node restart.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should "a" precede "node restart"?

vagimeli and others added 2 commits July 1, 2024 10:21
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli vagimeli merged commit 0597163 into opensearch-project:main Jul 1, 2024
5 checks passed
@hdhalter hdhalter added release-notes PR: Include this PR in the automated release notes and removed 5 - Editorial review PR: Editorial review in progress labels Jul 1, 2024
@hdhalter hdhalter added the 3 - Done Issue is done/complete label Jul 15, 2024
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Jul 24, 2024
…h-project#7414)

* Document new ingest and search pipeline allowlist settings

Signed-off-by: Andrew Ross <andrross@amazon.com>

* Update _ingest-pipelines/processors/index-processors.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/index-processors.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _search-plugins/search-pipelines/search-processors.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/index-processors.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _search-plugins/search-pipelines/search-processors.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _search-plugins/search-pipelines/search-processors.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

---------

Signed-off-by: Andrew Ross <andrross@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this pull request Jul 30, 2024
…h-project#7414)

* Document new ingest and search pipeline allowlist settings

Signed-off-by: Andrew Ross <andrross@amazon.com>

* Update _ingest-pipelines/processors/index-processors.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/index-processors.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _search-plugins/search-pipelines/search-processors.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/index-processors.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _search-plugins/search-pipelines/search-processors.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _search-plugins/search-pipelines/search-processors.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

---------

Signed-off-by: Andrew Ross <andrross@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete ingestion release-notes PR: Include this PR in the automated release notes v2.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants