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

Add documentation for new workflow steps #6740

Merged
merged 2 commits into from
Mar 21, 2024

Conversation

owaiskazi19
Copy link
Member

@owaiskazi19 owaiskazi19 commented Mar 20, 2024

Description

Create Search Pipeline - opensearch-project/flow-framework#569
Create Index - opensearch-project/flow-framework#574
Create Ingest Pipeline - opensearch-project/flow-framework#558

Issues Resolved

Part of opensearch-project/flow-framework#541

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.

@kolchfa-aws kolchfa-aws self-assigned this Mar 20, 2024
@kolchfa-aws kolchfa-aws added release-notes PR: Include this PR in the automated release notes v2.13.0 4 - Doc review PR: Doc review in progress labels Mar 20, 2024
Comment on lines 45 to 47
|`create_index`|[Create Index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/) | Creates a new OpenSearch index. The inputs include `index_name`, which should be the name of the index to be created, and `configurations`, which contains the payload body of a regular REST request for creating an index.
|`create_ingest_pipeline`|[Create Ingest Pipeline]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/) | Creates or updates an ingest pipeline. The inputs include `pipeline_id`, which should be the id of the pipeline, and `configurations`, which contains the payload body of a regular REST request for creating an ingest pipeline.
|`create_search_pipeline`|[Create Search Pipeline]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/creating-search-pipeline/) | Creates or updates a search pipeline. The inputs include `pipeline_id`, which should be the id of the pipeline, and `configurations`, which contains the payload body of a regular REST request for creating a search pipeline.
Copy link
Member

Choose a reason for hiding this comment

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

None of the other step types in this table detail the inputs unless they have special behavior (register+deploy).

Copy link
Member Author

Choose a reason for hiding this comment

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

These steps does have special behavior. We are passing the complete rest payload under a new field called configurations.

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.

LGTM. Thanks, @owaiskazi19!

@owaiskazi19 owaiskazi19 requested a review from dbwiddis March 20, 2024 23:18
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@owaiskazi19 @kolchfa-aws Just two minor changes. Thanks!

_automating-configurations/workflow-steps.md Outdated Show resolved Hide resolved
_automating-configurations/workflow-steps.md Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
@kolchfa-aws kolchfa-aws merged commit 8d70b08 into opensearch-project:main Mar 21, 2024
3 checks passed
CaptainDredge pushed a commit to CaptainDredge/documentation-website that referenced this pull request Mar 22, 2024
* Added documentation for new workflow steps

Signed-off-by: Owais Kazi <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Owais Kazi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 4 - Doc review PR: Doc review in progress labels Mar 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants