Document reprovision param for Update Workflow API #8172

dbwiddis · 2024-09-04T23:27:31Z

Description

Adds documentation for the Update Workflow API reprovision parameter

Issues Resolved

Resolves #8166

Version

2.17.0

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.

Signed-off-by: Daniel Widdis <[email protected]>

github-actions · 2024-09-04T23:27:42Z

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

dbwiddis · 2024-09-04T23:30:43Z

@amitgalitz @ohltyler Can you please provide a tech review for this since @joshpalis is unavailable and you either reviewed the PR or have used the feature from the front end?

Adds reprovision API to support updating search pipelines, ingest pipelines index settings flow-framework#804

dbwiddis · 2024-09-04T23:34:48Z

_automating-configurations/api/create-workflow.md

@@ -72,12 +72,26 @@ PUT /_plugins/_flow_framework/workflow/<workflow_id>?update_fields=true
 You cannot specify both the `provision` and `update_fields` parameters at the same time.
 {: .note}

+If a workflow has been provisioned, you can update and reprovision the full template:


I expect this section to create a merge conflict when #8171 is merged. This section should go above that new content as it's directly related to updating. I'll resolve conflicts when the time comes.

amitgalitz · 2024-09-04T23:35:44Z

_automating-configurations/api/create-workflow.md

+{% include copy-curl.html %}
+
+You can add new steps to the workflow but not delete them. Only steps for index settings, search pipelines, and ingest pipelines are currently supported for updating.
+{: .note}


The {: .note} is not producing anything specific in markdown, can we remove?

I think that renders on the actual documentation page, see the similar one above which renders like this:

I see, I am okay with it then

I anticipate we'll make this particular paragraph more detailed and link to a whole separate page (like the use case templates) for the remainder of the feature, so just trying to add the minimum this time.

Correct, the {: .note} renders as a blue callout.

Doesn't render in GitHub but does render on the doc site.

amitgalitz · 2024-09-04T23:36:02Z

_automating-configurations/api/create-workflow.md

+  <updated complete template>
+}
+```
+{% include copy-curl.html %}


can be removed I assume

I'll leave that to doc reviewers. I see the <placeholder> stuff used in other copy/paste.

Yeah I see that now in other locations

We typically want to spell out everything in the documentation in order to avoid confusion. This request clearly shows the reprovision query parameter and specifies that it needs to be a complete template, so we should keep this here. The template is very big so it's fine to use a descriptive placeholder.

ohltyler

Nothing to add from @amitgalitz comments. Will approve once those are resolved

dbwiddis · 2024-09-04T23:53:50Z

Nothing to add from @amitgalitz comments. Will approve once those are resolved

I don't think there's anything to do on those. :)

kolchfa-aws

Thank you, @dbwiddis! Just a couple of suggestions, otherwise LGTM.

_automating-configurations/api/create-workflow.md

kolchfa-aws · 2024-09-05T13:25:09Z

_automating-configurations/api/create-workflow.md

+  <updated complete template>
+}
+```
+{% include copy-curl.html %}


We typically want to spell out everything in the documentation in order to avoid confusion. This request clearly shows the reprovision query parameter and specifies that it needs to be a complete template, so we should keep this here. The template is very big so it's fine to use a descriptive placeholder.

_automating-configurations/api/create-workflow.md

kolchfa-aws · 2024-09-05T13:26:38Z

_automating-configurations/api/create-workflow.md

+{% include copy-curl.html %}
+
+You can add new steps to the workflow but not delete them. Only steps for index settings, search pipelines, and ingest pipelines are currently supported for updating.
+{: .note}


Correct, the {: .note} renders as a blue callout.

kolchfa-aws · 2024-09-05T13:27:03Z

_automating-configurations/api/create-workflow.md

+{% include copy-curl.html %}
+
+You can add new steps to the workflow but not delete them. Only steps for index settings, search pipelines, and ingest pipelines are currently supported for updating.
+{: .note}


Doesn't render in GitHub but does render on the doc site.

_automating-configurations/api/create-workflow.md

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>

kolchfa-aws · 2024-09-05T15:05:20Z

Applying "Done but waiting to merge" label to put this in the 2.17 editorial queue starting 9/11. This PR will be merged before the release.

dbwiddis · 2024-09-05T15:47:23Z

Applying "Done but waiting to merge" label to put this in the 2.17 editorial queue starting 9/11. This PR will be merged before the release.

Note that when #8171 is merged, it may create a merge conflict with this. I'll keep an eye out and rebase accordingly.

kolchfa-aws · 2024-09-05T16:12:58Z

Noted. This will likely be merged first because it's a 2.17 PR and will be prioritized higher for editorial review.

natebower

@dbwiddis @kolchfa-aws Please see my changes and let me know if you have any questions. Thanks!

_automating-configurations/api/create-workflow.md

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>

…t#8172) * Document reprovision param for Update Workflow API Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> --------- Signed-off-by: Daniel Widdis <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

Document reprovision param for Update Workflow API

79ae861

Signed-off-by: Daniel Widdis <[email protected]>

dbwiddis requested review from kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners September 4, 2024 23:27

github-actions bot assigned kolchfa-aws Sep 4, 2024

dbwiddis added 3 - Tech review PR: Tech review in progress v2.17.0 labels Sep 4, 2024

dbwiddis commented Sep 4, 2024

View reviewed changes

amitgalitz reviewed Sep 4, 2024

View reviewed changes

ohltyler reviewed Sep 4, 2024

View reviewed changes

ohltyler approved these changes Sep 5, 2024

View reviewed changes

dbwiddis added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Sep 5, 2024

kolchfa-aws approved these changes Sep 5, 2024

View reviewed changes

kolchfa-aws added the release-notes PR: Include this PR in the automated release notes label Sep 5, 2024

dbwiddis and others added 3 commits September 5, 2024 07:35

Update _automating-configurations/api/create-workflow.md

cfb2862

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>

Update _automating-configurations/api/create-workflow.md

bfe6e58

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>

Update _automating-configurations/api/create-workflow.md

67eb5ac

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>

kolchfa-aws added 6 - Done but waiting to merge PR: The work is done and ready to merge 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Sep 5, 2024

dbwiddis mentioned this pull request Sep 5, 2024

Document use_case param for Create Workflow API, link to existing docs #8171

Merged

1 task

natebower reviewed Sep 11, 2024

View reviewed changes

_automating-configurations/api/create-workflow.md Outdated Show resolved Hide resolved

Update _automating-configurations/api/create-workflow.md

cf55dbc

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>

kolchfa-aws merged commit f44deb2 into opensearch-project:main Sep 11, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document reprovision param for Update Workflow API #8172

Document reprovision param for Update Workflow API #8172

dbwiddis commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

dbwiddis commented Sep 4, 2024

dbwiddis Sep 4, 2024

amitgalitz Sep 4, 2024

dbwiddis Sep 4, 2024

amitgalitz Sep 4, 2024

dbwiddis Sep 5, 2024

kolchfa-aws Sep 5, 2024

kolchfa-aws Sep 5, 2024

amitgalitz Sep 4, 2024

dbwiddis Sep 4, 2024

amitgalitz Sep 4, 2024

kolchfa-aws Sep 5, 2024

ohltyler left a comment

dbwiddis commented Sep 4, 2024

kolchfa-aws left a comment

kolchfa-aws Sep 5, 2024

kolchfa-aws Sep 5, 2024

kolchfa-aws Sep 5, 2024

kolchfa-aws commented Sep 5, 2024

dbwiddis commented Sep 5, 2024

kolchfa-aws commented Sep 5, 2024

natebower left a comment

Document reprovision param for Update Workflow API #8172

Document reprovision param for Update Workflow API #8172

Conversation

dbwiddis commented Sep 4, 2024

Description

Issues Resolved

Version

Checklist

github-actions bot commented Sep 4, 2024

dbwiddis commented Sep 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ohltyler left a comment

Choose a reason for hiding this comment

dbwiddis commented Sep 4, 2024

kolchfa-aws left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kolchfa-aws commented Sep 5, 2024

dbwiddis commented Sep 5, 2024

kolchfa-aws commented Sep 5, 2024

natebower left a comment

Choose a reason for hiding this comment