Skip to content

[DOC] Update ingest pipelines content and page navigation #4285

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 41 commits into from
Closed

[DOC] Update ingest pipelines content and page navigation #4285

wants to merge 41 commits into from

Conversation

@vagimeli
Copy link
Contributor

@vagimeli vagimeli commented Jun 7, 2023

Description

Updates ingest pipelines content and page navigation

Issues Resolved

#4193
#4283

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@vagimeli
Update content and page navigation
4fafff4 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli vagimeli requested review from cwillum and hdhalter as code owners June 7, 2023 22:11
@vagimeli vagimeli self-assigned this Jun 7, 2023
vagimeli added 4 commits June 7, 2023 16:35
@vagimeli
Update create-update-ingest.md
0f99dbc 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Update index.md
e878d11 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Update get-ingest.md
897bf65 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Update simulate-ingest.md
ac54479 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli vagimeli added xx-documentation Tech review PR: Tech review in progress labels Jun 8, 2023
@vagimeli vagimeli linked an issue Jun 8, 2023 that may be closed by this pull request
[DOC] Move ingest pipelines documentation to Managing Indexes #4283
Closed
4 tasks
heemin32
heemin32 reviewed Jun 8, 2023
View reviewed changes
vagimeli and others added 11 commits June 9, 2023 14:38
@vagimeli
Address tech input
9edac34 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/create-update-ingest.md
005a2bf 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/create-update-ingest.md
e941b09 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/delete-ingest.md
073211b 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/simulate-ingest.md
44eae15 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/simulate-ingest.md
714f758 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/simulate-ingest.md
837552a 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/simulate-ingest.md
69cf081 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/delete-ingest.md
410a3f7 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/index.md
d68d5ae 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @heemin32
Update _api-reference/ingest-apis/get-ingest.md
ce55172 
Co-authored-by: Heemin Kim <heemin@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
kolchfa-aws
kolchfa-aws reviewed Jun 17, 2023
View reviewed changes
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see my comments and let me know if you'd like to discuss. I would also create more explicit examples for this documentation. I'll help create examples offline.

kolchfa-aws and others added 13 commits June 20, 2023 21:15
@kolchfa-aws
Modified example requests and responses
556880c 
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/index.md
5c839a3 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/index.md
398bf05 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/index.md
4f9e963 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/index.md
65e72e0 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Update ingest-pipelines.md
8cb9425 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/ingest-pipelines.md
940b7f9 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Update index.md
79ee9e9 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/ingest-pipelines.md
77892e8 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/ingest-pipelines.md
b07d196 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/ingest-pipelines.md
8c33a4a 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/ingest-pipelines.md
66e0fd3 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @kolchfa-aws
Update _api-reference/ingest-apis/ingest-pipelines.md
6d538d8 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
vagimeli commented Jun 21, 2023
View reviewed changes
vagimeli added 5 commits June 21, 2023 11:43
@vagimeli
Update ingest-pipelines.md
1c6cc05 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy edits
d7ec21e 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy edits
6f8ce5c 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy edits
b5e3839 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy edits
4970c58 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy link
Contributor Author

See PR #4299. Revised pipeline documentation included in that PR.

@vagimeli vagimeli closed this Jul 31, 2023
heemin32
heemin32 reviewed Jul 31, 2023
View reviewed changes
Copy link
Contributor

@heemin32 heemin32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will continue the review in another PR.

_api-reference/ingest-apis/ingest-pipelines.md

The following are prerequisites for using OpenSearch ingest pipelines:

- <SME insert information>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this line from description above could be one of prerequisites. When using ingest in production environments, your cluster should contain at least one node with the ingest role.

In addition to that, following prerequisites is needed when security features are enabled.

If the OpenSearch security features are enabled, you must have the `cluster_manage_pipelines` permission to manage ingest pipelines.

@vagimeli vagimeli mentioned this pull request Nov 6, 2023
Closed
45 tasks
@kolchfa-aws kolchfa-aws deleted the pipelines-4283 branch March 28, 2024 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kolchfa-aws kolchfa-aws kolchfa-aws left review comments

@cwillum cwillum Awaiting requested review from cwillum

@hdhalter hdhalter Awaiting requested review from hdhalter

@Naarcha-AWS Naarcha-AWS Awaiting requested review from Naarcha-AWS

@ananzh ananzh Awaiting requested review from ananzh

@seanneumann seanneumann Awaiting requested review from seanneumann

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@natebower natebower Awaiting requested review from natebower natebower is a code owner

+1 more reviewer

@heemin32 heemin32 heemin32 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@vagimeli vagimeli

Labels

Content gap

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[DOC] Move ingest pipelines documentation to Managing Indexes

4 participants

@vagimeli @heemin32 @kolchfa-aws