Files
OpenSearch-Docs-Cn/_automating-workflows/workflow-settings.md
T
6c92b54eba Add flow framework documentation (#6257)
* Add flow framework documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _automating-workflows/api/create-workflow.md

Co-authored-by: Owais Kazi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Add callout of edges being optional

Signed-off-by: Fanit Kolchina <[email protected]>

* Add unregister to word list

Signed-off-by: Fanit Kolchina <[email protected]>

* Add registering local pretrained and custom models

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _automating-workflows/api/deprovision-workflow.md

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _automating-workflows/workflow-steps.md

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Added Flow Framework plugin to Vale

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

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

* More editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _automating-workflows/api/get-workflow-status.md

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

* Update _automating-workflows/api/get-workflow-status.md

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

* Add note about provisioning

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _automating-workflows/index.md

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

* Update _automating-workflows/workflow-steps.md

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

* More editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Removed code font from headings

Signed-off-by: Fanit Kolchina <[email protected]>

* Add agent documentation links

Signed-off-by: Fanit Kolchina <[email protected]>

* Add experimental label and more links

Signed-off-by: Fanit Kolchina <[email protected]>

* Add sample templates link

Signed-off-by: Fanit Kolchina <[email protected]>

* Added a tracking issue to warning

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Owais Kazi <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2024-02-07 18:44:49 -05:00

1.3 KiB

layout, title, nav_order
layout title nav_order
default Workflow settings 30

Workflow settings

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.
{: .warning}

The following keys represent configurable workflow settings.

Setting Data type Default value Description
plugins.flow_framework.enabled Boolean false Whether the Flow Framework API is enabled.
plugins.flow_framework.max_workflows Integer 1000 The maximum number of workflows that you can create. When the limit is above 1,000, the number of existing workflows is defined as a lower bound for performance reasons, so the actual maximum may slightly exceed this value.
plugins.flow_framework.max_workflow_steps Integer 50 The maximum number of steps a workflow can have.
plugins.flow_framework.request_timeout Time units 10s The default timeout for REST requests, which applies to internal search queries.
plugins.flow_framework.task_request_retry_duration Time units 5s When steps correspond to an API that produces a task_id, OpenSearch will retry them at this interval until completion.