Document new ingest and search pipeline allowlist settings (#7414)

* Document new ingest and search pipeline allowlist settings Signed-off-by: Andrew Ross <[email protected]> * Update _ingest-pipelines/processors/index-processors.md Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/index-processors.md Signed-off-by: Melissa Vagi <[email protected]> * Update _search-plugins/search-pipelines/search-processors.md Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/index-processors.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _search-plugins/search-pipelines/search-processors.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _search-plugins/search-pipelines/search-processors.md Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Andrew Ross <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Jul 1, 2024 · 0597163 · 0597163
1 parent 61fa844
commit 0597163
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/_ingest-pipelines/processors/index-processors.md b/_ingest-pipelines/processors/index-processors.md
@@ -71,3 +71,7 @@ Processor type | Description
 ## Batch-enabled processors
 
 Some processors support batch ingestion---they can process multiple documents at the same time as a batch. These batch-enabled processors usually provide better performance when using batch processing. For batch processing, use the [Bulk API]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/) and provide a `batch_size` parameter. All batch-enabled processors have a batch mode and a single-document mode. When you ingest documents using the `PUT` method, the processor functions in single-document mode and processes documents in series. Currently, only the `text_embedding` and `sparse_encoding` processors are batch enabled. All other processors process documents one at a time.
+
+## Selectively enabling processors
+
+Processors defined by the [ingest-common module](https://github.com/opensearch-project/OpenSearch/blob/2.x/modules/ingest-common/src/main/java/org/opensearch/ingest/common/IngestCommonPlugin.java) can be selectively enabled by providing the `ingest-common.processors.allowed` cluster setting. If not provided, then all processors are enabled by default. Specifying an empty list disables all processors. If the setting is changed to remove previously enabled processors, then any pipeline using a disabled processor will fail after node restart when the new setting takes effect.
diff --git a/_search-plugins/search-pipelines/search-processors.md b/_search-plugins/search-pipelines/search-processors.md
@@ -121,3 +121,7 @@ The response contains the `search_pipelines` object that lists the available req
 
 In addition to the processors provided by OpenSearch, additional processors may be provided by plugins.
 {: .note}
+
+## 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, then all processors are enabled. An empty list disables all processors. Removing enabled processors causes pipelines using them to fail after a node restart.