Skip to content

[Backport 2.x] Add allowlist setting for search-pipeline-common processors#14582

Merged
reta merged 1 commit into2.xfrom
backport/backport-14562-to-2.x
Jun 27, 2024
Merged

[Backport 2.x] Add allowlist setting for search-pipeline-common processors#14582
reta merged 1 commit into2.xfrom
backport/backport-14562-to-2.x

Conversation

@opensearch-trigger-bot
Copy link
Copy Markdown
Contributor

Backport d9e9944 from #14562.

Add a new static setting that lets an operator choose specific search
pipeline processors to enable by name. The behavior is as follows:

- If the allowlist setting is not defined, all installed processors are
  enabled. This is the status quo.
- If the allowlist setting is defined as the empty set, then all processors
  are disabled.
- If the allowlist setting contains the names of valid processors, only those
  processors are enabled.
- If the allowlist setting contains a name of a processor that does not exist,
  then the server will fail to start with an IllegalStateException
  listing which processors were defined in the allowlist but are not
  installed.
- If the allowlist setting is changed between server restarts then any
  ingest pipeline using a now-disabled processor will fail. This is the
  same experience if a pipeline used a processor defined by a plugin but
  then that plugin were to be uninstalled across restarts.

A distinct setting exists for each of request, response, and search phase
results processors.

Related to #14439

Signed-off-by: Andrew Ross <andrross@amazon.com>
(cherry picked from commit d9e9944)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Jun 27, 2024

Codecov Report

Attention: Patch coverage is 96.77419% with 1 line in your changes missing coverage. Please review.

Project coverage is 71.49%. Comparing base (0095fd1) to head (407cd79).
Report is 1 commits behind head on 2.x.

Files Patch % Lines
...eline/common/SearchPipelineCommonModulePlugin.java 96.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##                2.x   #14582   +/-   ##
=========================================
  Coverage     71.49%   71.49%           
- Complexity    62304    62369   +65     
=========================================
  Files          5102     5102           
  Lines        293146   293174   +28     
  Branches      42716    42717    +1     
=========================================
+ Hits         209585   209611   +26     
- Misses        65877    65951   +74     
+ Partials      17684    17612   -72     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions
Copy link
Copy Markdown
Contributor

✅ Gradle check result for 407cd79: SUCCESS

@reta reta merged commit 58467f6 into 2.x Jun 27, 2024
@andrross andrross deleted the backport/backport-14562-to-2.x branch June 27, 2024 19:01
kkewwei pushed a commit to kkewwei/OpenSearch that referenced this pull request Jul 24, 2024
…ch-project#14562) (opensearch-project#14582)

Add a new static setting that lets an operator choose specific search
pipeline processors to enable by name. The behavior is as follows:

- If the allowlist setting is not defined, all installed processors are
  enabled. This is the status quo.
- If the allowlist setting is defined as the empty set, then all processors
  are disabled.
- If the allowlist setting contains the names of valid processors, only those
  processors are enabled.
- If the allowlist setting contains a name of a processor that does not exist,
  then the server will fail to start with an IllegalStateException
  listing which processors were defined in the allowlist but are not
  installed.
- If the allowlist setting is changed between server restarts then any
  ingest pipeline using a now-disabled processor will fail. This is the
  same experience if a pipeline used a processor defined by a plugin but
  then that plugin were to be uninstalled across restarts.

A distinct setting exists for each of request, response, and search phase
results processors.

Related to opensearch-project#14439

(cherry picked from commit d9e9944)

Signed-off-by: Andrew Ross <andrross@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Signed-off-by: kkewwei <kkewwei@163.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant