opensearch-docs-cn/_automating-configurations/workflow-settings.md

21 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

Add flow framework documentation (#6257) * Add flow framework documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/create-workflow.md Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add callout of edges being optional Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add unregister to word list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add registering local pretrained and custom models Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/deprovision-workflow.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Added Flow Framework plugin to Vale Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add note about provisioning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/index.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed code font from headings Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add agent documentation links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add experimental label and more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sample templates link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added a tracking issue to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-02-07 18:44:49 -05:00
---
layout: default
title: Workflow settings
nav_order: 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](https://github.com/opensearch-project/flow-framework/issues/475).
{: .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. |