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

[Backport 2.x] Add allowlist setting for ingest-common processors #14561

Merged
merged 2 commits into from
Jun 26, 2024

Conversation

opensearch-trigger-bot[bot]
Copy link
Contributor

Backport a99b494 from #14479.

Add a new static setting that lets an operator choose specific ingest
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.

Related to #14439

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

❌ Gradle check result for 7acfe66: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

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

Pushed a commit to fix compilation errors related to the "module plugin" class renaming that happened on main

Copy link
Contributor

✅ Gradle check result for 0eff3eb: SUCCESS

Copy link

codecov bot commented Jun 26, 2024

Codecov Report

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

Project coverage is 71.42%. Comparing base (f2d8e1d) to head (0eff3eb).

Files Patch % Lines
...g/opensearch/ingest/common/IngestCommonPlugin.java 94.73% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##                2.x   #14561      +/-   ##
============================================
+ Coverage     71.39%   71.42%   +0.03%     
- Complexity    62268    62364      +96     
============================================
  Files          5102     5102              
  Lines        293130   293146      +16     
  Branches      42715    42716       +1     
============================================
+ Hits         209275   209394     +119     
+ Misses        66203    66194       -9     
+ Partials      17652    17558      -94     

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

kkewwei pushed a commit to kkewwei/OpenSearch that referenced this pull request Jul 24, 2024
…ensearch-project#14561)

* Add allowlist setting for ingest-common processors (opensearch-project#14479)

Add a new static setting that lets an operator choose specific ingest
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.

Related to opensearch-project#14439

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

* Fix test issues due to class renaming on main

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

---------

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>
Co-authored-by: Andrew Ross <andrross@amazon.com>
Signed-off-by: kkewwei <kkewwei@163.com>
@dbwiddis dbwiddis deleted the backport/backport-14479-to-2.x branch July 24, 2024 16:05
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.

3 participants