Documentation for the Data Prepper OpenSearch source #5144
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Taylor Gray <tylgry@amazon.com>
graytaylor0
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
Naarcha-AWS
reviewed
Oct 9, 2023
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
approved these changes
Oct 11, 2023
natebower
requested changes
Oct 11, 2023
There was a problem hiding this comment.
@Naarcha-AWS Requesting changes so I can verify a few lines. Please tag me when complete. Thanks!
| ... | ||
| ``` | ||
|
|
||
| To use the `opensearch` source with all configuration settings, including `indices`, `scheduling`, `search_options`, and `connection`, add the following exampe to your `pipeline.yaml` file: |
There was a problem hiding this comment.
A noun should follow "example". Example what?
|
|
||
| #### Creating a pipeline | ||
|
|
||
| Within your `pipelines.yaml` file, specify the OpenSearch Serverless collection endpoint as the `hosts` option. In addition, you must set the `serverless` option to `true`. Specify the pipeline role in the `sts_role_arn` option, as shown in the following example: |
There was a problem hiding this comment.
Should pipelines.yaml be pipeline.yaml?
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
| Use the following setting under the `include` and `exclude` options to indicate the regex pattern for the index. | ||
| Option | Required | Type | Description | ||
| :--- |:----|:-----------------| :--- | ||
| `index_name_regex` | Yes | Regex String | The regex pattern to match indexes against. |
There was a problem hiding this comment.
Suggested change
| `index_name_regex` | Yes | Regex String | The regex pattern to match indexes against. | |
| `index_name_regex` | Yes | Regex string | The regex pattern to match indexes against. |
Naarcha-AWS
reviewed
Oct 11, 2023
|
|
||
| ## OpenSearch cluster security | ||
|
|
||
| In order to pull data from an OpenSearch cluster using the `opensearch` source plugin, you must specify your username and password within the pipeline configuration. The following example `pipelines.yaml` file demonstrates how to specify the default admin security credentials: |
There was a problem hiding this comment.
Suggested change
| In order to pull data from an OpenSearch cluster using the `opensearch` source plugin, you must specify your username and password within the pipeline configuration. The following example `pipelines.yaml` file demonstrates how to specify the default admin security credentials: | |
| In order to pull data from an OpenSearch cluster using the `opensearch` source plugin, you must specify your username and password within the pipeline configuration. The following example `pipeline.yaml` file demonstrates how to specify the default admin security credentials: |
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Naarcha-AWS
reviewed
Oct 11, 2023
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
natebower
reviewed
Oct 11, 2023
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com>
Naarcha-AWS
reviewed
Oct 11, 2023
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Oct 11, 2023
* Documentation for the Data Prepper OpenSearch source Signed-off-by: Taylor Gray <tylgry@amazon.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Update opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Taylor Gray <tylgry@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit f4984fb) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS
added a commit
that referenced
this pull request
Oct 12, 2023
* Documentation for the Data Prepper OpenSearch source * Update _data-prepper/pipelines/configuration/sources/opensearch.md * Update opensearch.md * Apply suggestions from code review * Update _data-prepper/pipelines/configuration/sources/opensearch.md * Update _data-prepper/pipelines/configuration/sources/opensearch.md * Apply suggestions from code review * Update opensearch.md * Apply suggestions from code review * Update _data-prepper/pipelines/configuration/sources/opensearch.md * Update _data-prepper/pipelines/configuration/sources/opensearch.md * Apply suggestions from code review --------- (cherry picked from commit f4984fb) Signed-off-by: Taylor Gray <tylgry@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.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: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli
pushed a commit
that referenced
this pull request
Oct 13, 2023
* Documentation for the Data Prepper OpenSearch source Signed-off-by: Taylor Gray <tylgry@amazon.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Update opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Taylor Gray <tylgry@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
harshavamsi
pushed a commit
to harshavamsi/documentation-website
that referenced
this pull request
Oct 31, 2023
…ect#5144) * Documentation for the Data Prepper OpenSearch source Signed-off-by: Taylor Gray <tylgry@amazon.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Update opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Taylor Gray <tylgry@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli
pushed a commit
that referenced
this pull request
Dec 21, 2023
* Documentation for the Data Prepper OpenSearch source Signed-off-by: Taylor Gray <tylgry@amazon.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Update opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update opensearch.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Update _data-prepper/pipelines/configuration/sources/opensearch.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Taylor Gray <tylgry@amazon.com> Signed-off-by: Taylor Gray <graytaylor0@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds documentation for the OpenSearch source of Data Prepper that will be released in Data Prepper 2.5
Issues Resolved
Resolves #5112
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.