Add documentation for Deprovision Workflow API allow_delete parameter #7639

dbwiddis · 2024-07-08T02:32:29Z

Description

Documents the new allow_delete parameter for the Deprovision Workflow API

Issues Resolved

Fixes #7648

Corresponding PR:

Add allow_delete parameter to Deprovision API flow-framework#763

Version

Targeted to 2.16 release.

Frontend features

Will be used by Flow Framework Dashboards front-end, not yet released.

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.

_automating-configurations/api/deprovision-workflow.md

ohltyler

LGTM

owaiskazi19

Overall LGTM with a comment

_search-plugins/search-pipelines/deleting-search-pipeline.md

dbwiddis · 2024-07-12T18:20:27Z

Putting this back into tech review as we consider whether to allow users to use the new steps

dbwiddis · 2024-07-16T14:52:35Z

OK, removed the new steps. Kept the new (missing) delete pipeline doc even if it's no longer referenced in this PR. Ready for doc review. (CC: @kolchfa-aws)

Open question: One mention of allow_delete refers to the step types and another refers to the type of resources being deleted. Technically the former one is how it's coded but the latter one seems more intuitive to me. Open to suggestions whether to leave as is or make them both the same (in which case, which one?)

kolchfa-aws

Thank you, @dbwiddis! Re: your question about referring to resources vs. step types, what lines are you referring to? I agree that it's more intuitive to refer to resources but I want to make sure we're talking about the same sentences.

kolchfa-aws · 2024-07-19T20:09:42Z

_automating-configurations/api/deprovision-workflow.md

@@ -9,7 +9,9 @@ nav_order: 70

 When you no longer need a workflow, you can deprovision its resources. Most workflow steps that create a resource have corresponding workflow steps to reverse that action. To retrieve all resources currently created for a workflow, call the [Get Workflow Status API]({{site.url}}{{site.baseurl}}/automating-configurations/api/get-workflow-status/). When you call the Deprovision Workflow API, resources included in the `resources_created` field of the Get Workflow Status API response will be removed using a workflow step corresponding to the one that provisioned them.

-The workflow executes the provisioning workflow steps in reverse order. If failures occur because of resource dependencies, such as preventing deletion of a registered model if it is still deployed, the workflow attempts retries.
+The workflow executes the provisioning workflow steps in reverse order. If failures occur because of resource dependencies, such as preventing deletion of a registered model if it is still deployed, the workflow retries as long as at least one resource was deleted.


Suggested change

The workflow executes the provisioning workflow steps in reverse order. If failures occur because of resource dependencies, such as preventing deletion of a registered model if it is still deployed, the workflow retries as long as at least one resource was deleted.

The workflow executes the provisioning workflow steps in reverse order. If a failure occurs because of a resource dependency, such as trying to delete a registered model that is still deployed, then the workflow retries the failing step as long as at least one resource was deleted.

Edited suggestion to add "then". In the first sentence, is the second instance of "workflow" necessary?

Good call out. I'll remove the second "workflow"

natebower

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

natebower · 2024-07-22T13:33:17Z

_automating-configurations/api/deprovision-workflow.md

@@ -9,7 +9,9 @@ nav_order: 70

 When you no longer need a workflow, you can deprovision its resources. Most workflow steps that create a resource have corresponding workflow steps to reverse that action. To retrieve all resources currently created for a workflow, call the [Get Workflow Status API]({{site.url}}{{site.baseurl}}/automating-configurations/api/get-workflow-status/). When you call the Deprovision Workflow API, resources included in the `resources_created` field of the Get Workflow Status API response will be removed using a workflow step corresponding to the one that provisioned them.

-The workflow executes the provisioning workflow steps in reverse order. If failures occur because of resource dependencies, such as preventing deletion of a registered model if it is still deployed, the workflow attempts retries.
+The workflow executes the provisioning workflow steps in reverse order. If failures occur because of resource dependencies, such as preventing deletion of a registered model if it is still deployed, the workflow retries as long as at least one resource was deleted.


Edited suggestion to add "then". In the first sentence, is the second instance of "workflow" necessary?

_automating-configurations/api/deprovision-workflow.md

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com>

Signed-off-by: Daniel Widdis <widdis@gmail.com>

…opensearch-project#7639) * Add documentation for Deprovision Workflow API allow_delete parameter Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add new steps and missing delete search pipeline doc Signed-off-by: Daniel Widdis <widdis@gmail.com> * Revert changes to workflow steps. Users can't use these new step types Signed-off-by: Daniel Widdis <widdis@gmail.com> * Update _automating-configurations/api/deprovision-workflow.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> * Update _automating-configurations/api/deprovision-workflow.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> * Update _automating-configurations/api/deprovision-workflow.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> * Remove redundant use of workflow, accept other edits Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com>

…opensearch-project#7639) * Add documentation for Deprovision Workflow API allow_delete parameter Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add new steps and missing delete search pipeline doc Signed-off-by: Daniel Widdis <widdis@gmail.com> * Revert changes to workflow steps. Users can't use these new step types Signed-off-by: Daniel Widdis <widdis@gmail.com> * Update _automating-configurations/api/deprovision-workflow.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> * Update _automating-configurations/api/deprovision-workflow.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> * Update _automating-configurations/api/deprovision-workflow.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> * Remove redundant use of workflow, accept other edits Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Sander van de Geijn <sandervandegeijn@icloud.com>

dbwiddis requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners July 8, 2024 02:32

dbwiddis mentioned this pull request Jul 8, 2024

Add allow_delete parameter to Deprovision API opensearch-project/flow-framework#763

Merged

dbwiddis added v2.16.0 3 - Tech review PR: Tech review in progress labels Jul 8, 2024

kolchfa-aws self-assigned this Jul 8, 2024

dbwiddis commented Jul 8, 2024

View reviewed changes

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

ohltyler mentioned this pull request Jul 8, 2024

[FEATURE] Support optional force deletion of certain resources opensearch-project/flow-framework#748

Closed

dbwiddis mentioned this pull request Jul 8, 2024

[DOC] Flow Framework Deprovision API allow_delete parameter #7648

Closed

4 tasks

ohltyler approved these changes Jul 11, 2024

View reviewed changes

owaiskazi19 reviewed Jul 11, 2024

View reviewed changes

_search-plugins/search-pipelines/deleting-search-pipeline.md Show resolved Hide resolved

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

owaiskazi19 approved these changes Jul 12, 2024

View reviewed changes

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

hdhalter added the release-notes PR: Include this PR in the automated release notes label Jul 15, 2024

dbwiddis force-pushed the allow-delete branch 2 times, most recently from af6782a to e6b48ba Compare July 16, 2024 14:49

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

kolchfa-aws approved these changes Jul 19, 2024

View reviewed changes

kolchfa-aws added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jul 19, 2024

natebower reviewed Jul 22, 2024

View reviewed changes

dbwiddis and others added 6 commits July 22, 2024 09:06

Add documentation for Deprovision Workflow API allow_delete parameter

e3cabe9

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Add new steps and missing delete search pipeline doc

8ff5ada

Signed-off-by: Daniel Widdis <widdis@gmail.com>

Revert changes to workflow steps. Users can't use these new step types

1767580

Signed-off-by: Daniel Widdis <widdis@gmail.com>

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

127187c

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com>

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

57d3480

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com>

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

67dba03

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis force-pushed the allow-delete branch from 27f3d6c to 3f75a5c Compare July 22, 2024 16:08

Remove redundant use of workflow, accept other edits

c1590b6

Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis force-pushed the allow-delete branch from 3f75a5c to c1590b6 Compare July 22, 2024 16:09

kolchfa-aws merged commit 1734199 into opensearch-project:main Jul 22, 2024
5 checks passed

hdhalter added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Jul 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for Deprovision Workflow API allow_delete parameter #7639

Add documentation for Deprovision Workflow API allow_delete parameter #7639

dbwiddis commented Jul 8, 2024 •

edited

Loading

ohltyler left a comment

owaiskazi19 left a comment

dbwiddis commented Jul 12, 2024

dbwiddis commented Jul 16, 2024 •

edited

Loading

kolchfa-aws left a comment

kolchfa-aws Jul 19, 2024 •

edited by natebower

Loading

natebower Jul 22, 2024

dbwiddis Jul 22, 2024

natebower left a comment

natebower Jul 22, 2024

	The workflow executes the provisioning workflow steps in reverse order. If failures occur because of resource dependencies, such as preventing deletion of a registered model if it is still deployed, the workflow retries as long as at least one resource was deleted.
	The workflow executes the provisioning workflow steps in reverse order. If a failure occurs because of a resource dependency, such as trying to delete a registered model that is still deployed, then the workflow retries the failing step as long as at least one resource was deleted.

Add documentation for Deprovision Workflow API allow_delete parameter #7639

Add documentation for Deprovision Workflow API allow_delete parameter #7639

Conversation

dbwiddis commented Jul 8, 2024 • edited Loading

Description

Issues Resolved

Version

Frontend features

Checklist

ohltyler left a comment

Choose a reason for hiding this comment

owaiskazi19 left a comment

Choose a reason for hiding this comment

dbwiddis commented Jul 12, 2024

dbwiddis commented Jul 16, 2024 • edited Loading

kolchfa-aws left a comment

Choose a reason for hiding this comment

kolchfa-aws Jul 19, 2024 • edited by natebower Loading

Choose a reason for hiding this comment

natebower Jul 22, 2024

Choose a reason for hiding this comment

dbwiddis Jul 22, 2024

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

natebower Jul 22, 2024

Choose a reason for hiding this comment

dbwiddis commented Jul 8, 2024 •

edited

Loading

dbwiddis commented Jul 16, 2024 •

edited

Loading

kolchfa-aws Jul 19, 2024 •

edited by natebower

Loading