Add the pipeline subdocument to the Sources document (#8211)

Signed-off-by: linghengqian <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
opensearch-project · Sep 13, 2024 · 8ba63fe · 8ba63fe
1 parent 27c02f9
commit 8ba63fe
Show file tree

Hide file tree

Showing 11 changed files with 41 additions and 10 deletions.
diff --git a/_data-prepper/pipelines/configuration/sources/documentdb.md b/_data-prepper/pipelines/configuration/sources/documentdb.md
@@ -3,7 +3,7 @@ layout: default
 title: documentdb
 parent: Sources
 grand_parent: Pipelines
-nav_order: 2
+nav_order: 10
 ---
 
 # documentdb

diff --git a/_data-prepper/pipelines/configuration/sources/dynamo-db.md b/_data-prepper/pipelines/configuration/sources/dynamo-db.md
@@ -3,7 +3,7 @@ layout: default
 title: dynamodb
 parent: Sources
 grand_parent: Pipelines
-nav_order: 3
+nav_order: 20
 ---
 
 # dynamodb

diff --git a/_data-prepper/pipelines/configuration/sources/http.md b/_data-prepper/pipelines/configuration/sources/http.md
@@ -3,7 +3,7 @@ layout: default
 title: http
 parent: Sources
 grand_parent: Pipelines
-nav_order: 5
+nav_order: 30
 redirect_from:
   - /data-prepper/pipelines/configuration/sources/http-source/
 ---

diff --git a/_data-prepper/pipelines/configuration/sources/kafka.md b/_data-prepper/pipelines/configuration/sources/kafka.md
@@ -3,7 +3,7 @@ layout: default
 title: kafka
 parent: Sources
 grand_parent: Pipelines
-nav_order: 6
+nav_order: 40
 ---
 
 # kafka

diff --git a/_data-prepper/pipelines/configuration/sources/opensearch.md b/_data-prepper/pipelines/configuration/sources/opensearch.md
@@ -3,7 +3,7 @@ layout: default
 title: opensearch
 parent: Sources
 grand_parent: Pipelines
-nav_order: 30
+nav_order: 50
 ---
 
 # opensearch

diff --git a/_data-prepper/pipelines/configuration/sources/otel-logs-source.md b/_data-prepper/pipelines/configuration/sources/otel-logs-source.md
@@ -3,7 +3,7 @@ layout: default
 title: otel_logs_source 
 parent: Sources
 grand_parent: Pipelines
-nav_order: 25
+nav_order: 60
 ---
 
 # otel_logs_source

diff --git a/_data-prepper/pipelines/configuration/sources/otel-metrics-source.md b/_data-prepper/pipelines/configuration/sources/otel-metrics-source.md
@@ -3,7 +3,7 @@ layout: default
 title: otel_metrics_source
 parent: Sources
 grand_parent: Pipelines
-nav_order: 10
+nav_order: 70
 ---
 
 # otel_metrics_source

diff --git a/_data-prepper/pipelines/configuration/sources/otel-trace-source.md b/_data-prepper/pipelines/configuration/sources/otel-trace-source.md
@@ -3,7 +3,7 @@ layout: default
 title: otel_trace_source
 parent: Sources
 grand_parent: Pipelines
-nav_order: 15
+nav_order: 80
 redirect_from:
   - /data-prepper/pipelines/configuration/sources/otel-trace/
 ---

diff --git a/_data-prepper/pipelines/configuration/sources/pipeline.md b/_data-prepper/pipelines/configuration/sources/pipeline.md
@@ -0,0 +1,31 @@
+---
+layout: default
+title: pipeline 
+parent: Sources
+grand_parent: Pipelines
+nav_order: 90
+---
+
+# pipeline
+
+Use the `pipeline` sink to read from another pipeline.
+
+## Configuration options
+
+The `pipeline` sink supports the following configuration options.
+
+| Option | Required | Type   | Description                            |
+|:-------|:---------|:-------|:---------------------------------------|
+| `name` | Yes      | String | The name of the pipeline to read from. |
+
+## Usage
+
+The following example configures a `pipeline` sink named `sample-pipeline` that reads from a pipeline named `movies`:
+
+```yaml
+sample-pipeline:
+  source:
+    - pipeline:
+        name: "movies"
+```
+{% include copy.html %}
diff --git a/_data-prepper/pipelines/configuration/sources/s3.md b/_data-prepper/pipelines/configuration/sources/s3.md
@@ -3,7 +3,7 @@ layout: default
 title: s3 source
 parent: Sources
 grand_parent: Pipelines
-nav_order: 20
+nav_order: 100
 ---
 
 # s3 source

diff --git a/_data-prepper/pipelines/configuration/sources/sources.md b/_data-prepper/pipelines/configuration/sources/sources.md
@@ -3,7 +3,7 @@ layout: default
 title: Sources
 parent: Pipelines
 has_children: true
-nav_order: 20
+nav_order: 110
 ---
 
 # Sources