diff --git a/explore-analyze/images/workflows-editor.png b/explore-analyze/images/workflows-editor.png new file mode 100644 index 0000000000..91ca8a4012 Binary files /dev/null and b/explore-analyze/images/workflows-editor.png differ diff --git a/explore-analyze/images/workflows-page.png b/explore-analyze/images/workflows-page.png new file mode 100644 index 0000000000..c30c8ca874 Binary files /dev/null and b/explore-analyze/images/workflows-page.png differ diff --git a/explore-analyze/toc.yml b/explore-analyze/toc.yml index 107434307c..dbfbcf9454 100644 --- a/explore-analyze/toc.yml +++ b/explore-analyze/toc.yml @@ -412,7 +412,7 @@ toc: - file: workflows/data.md children: - file: workflows/data/templating.md - - file: workflows/create-workflows.md + - file: workflows/author-workflows.md - file: workflows/monitor-troubleshoot.md - file: workflows/manage-workflows.md - hidden: workflows/use-cases.md diff --git a/explore-analyze/workflows/author-workflows.md b/explore-analyze/workflows/author-workflows.md new file mode 100644 index 0000000000..d35a5e5c52 --- /dev/null +++ b/explore-analyze/workflows/author-workflows.md @@ -0,0 +1,35 @@ +--- +applies_to: + stack: preview 9.3 + serverless: preview +description: Reference guide for the workflow YAML editor interface. +--- + +# Author workflows [workflows-yaml-editor] + +The YAML editor is the primary interface for creating and editing workflows. This page describes the editor's components and features. + +::::{admonition} Requirements +To use workflows, you must turn on the feature and ensure your role has the appropriate privileges. Refer to [](setup.md) to learn more. + +You must also have the appropriate subscription. Refer to the subscription page for [Elastic Cloud](https://www.elastic.co/subscriptions/cloud) and [Elastic Stack/self-managed](https://www.elastic.co/subscriptions) for the breakdown of available features and their associated subscription tiers. +:::: + + +:::{image} /explore-analyze/images/workflows-editor.png +:alt: A view of Workflows editor +:screenshot: +::: + +## Editor layout [workflows-editor-layout] + +The editor layout is composed of the following elements: + +| Component | Description | +|-----------|-------------| +| **Editor pane** | The main area for writing and editing workflows. To learn more about the expected workflow structure, refer to [](/explore-analyze/workflows.md) | +| **Actions menu** | A quick-add menu for pre-formatted [triggers](triggers.md) and [step types](steps.md). | +| **Save button** | Saves the current workflow. | +| **Run button** | Manually runs the entire workflow or an individual step.
- Entire workflow: Click the **Run** icon {icon}`play` (next to **Save**).
- Individual step: Select the step in the editor pane, then click the **Run** icon {icon}`play`. | +| **Executions tab** | Shows [execution history](monitor-troubleshoot.md) and real-time logs. | +| **Validation logs** | Shows validation successes and failures. Some common validation errors include:
- Invalid YAML syntax because of incorrect indentation or formatting
- Missing a required field or property (for example, `name`, `type`)
- The step type is unknown or doesn't match a valid action
- Invalid template syntax because of malformed template expression| \ No newline at end of file diff --git a/explore-analyze/workflows/create-workflows.md b/explore-analyze/workflows/create-workflows.md deleted file mode 100644 index fbfe17628f..0000000000 --- a/explore-analyze/workflows/create-workflows.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -applies_to: - stack: preview 9.3 - serverless: preview -description: Learn how to create and execute Elastic workflows. ---- - -# Create and run workflows \ No newline at end of file diff --git a/explore-analyze/workflows/manage-workflows.md b/explore-analyze/workflows/manage-workflows.md index 3bc67752ae..300726864d 100644 --- a/explore-analyze/workflows/manage-workflows.md +++ b/explore-analyze/workflows/manage-workflows.md @@ -2,7 +2,47 @@ applies_to: stack: preview 9.3 serverless: preview -description: Learn how to edit and manage existing Elastic workflows. +description: Learn how to view, organize, and manage your workflows. --- -# Manage workflows \ No newline at end of file +# Manage workflows [workflows-manage] + +The **Workflows** page allows you to view and manage all your workflows. From the page, you can create, edit, duplicate, delete, and more with your workflows. To find the **Workflows** page, use the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). + +::::{admonition} Requirements +To use workflows, you must turn on the feature and ensure your role has the appropriate privileges. Refer to [](setup.md) to learn more. + +You must also have the appropriate subscription. Refer to the subscription page for [Elastic Cloud](https://www.elastic.co/subscriptions/cloud) and [Elastic Stack/self-managed](https://www.elastic.co/subscriptions) for the breakdown of available features and their associated subscription tiers. +:::: + +:::{image} /explore-analyze/images/workflows-page.png +:alt: A view of Workflows editor +:screenshot: +::: + +## Available actions [workflow-available-actions] + +From the Workflows page, you can create new workflows, search and filter existing ones, manually trigger workflows, and more. + +### Create a workflow [workflow-create] + +Click **Create a new workflow** to open the YAML editor. Refer to [](/explore-analyze/workflows/author-workflows.md) to learn how to use the editor. + +### Search and filter [workflow-search-filter] + +Use the search bar to filter workflows by name, description, or tag. You can also use the **Enabled** filter to only show workflows that are turned on (enabled) or off (disabled), and the **Created By** filter to only show workflows created by the specified user. + +### Run a workflow [workflow-run] + +To instantly run a workflow, click the **Run** icon {icon}`play` for a workflow, or open the **All actions** menu ({icon}`boxes_vertical`) and click **Run**. This manually runs the workflow regardless of its specified triggers. Refer to [](/explore-analyze/workflows/monitor-troubleshoot.md) to learn about monitoring workflow runs. + +### Edit a workflow [workflow-edit] + +Click the **Edit** icon to open the workflow in the YAML editor. You can also open the **All actions** menu ({icon}`boxes_vertical`) and click **Edit**. + +### Turn a workflow on or off [workflow-enable-disable] + +Use the **Enabled** toggle to control whether a workflow can run: + +- **Enabled**: The workflow responds to its configured triggers. +- **Disabled**: The workflow does not run, even if triggered. \ No newline at end of file diff --git a/explore-analyze/workflows/monitor-troubleshoot.md b/explore-analyze/workflows/monitor-troubleshoot.md index 072172e330..7a917debff 100644 --- a/explore-analyze/workflows/monitor-troubleshoot.md +++ b/explore-analyze/workflows/monitor-troubleshoot.md @@ -5,4 +5,37 @@ applies_to: description: Learn how to monitor Elastic workflows executions and troubleshoot errors. --- -# Monitor and troubleshoot workflows \ No newline at end of file +# Monitor and troubleshoot workflows [workflows-monitor-troubleshoot] + +After you run a workflow, you can track its progress in real time, review past executions, and diagnose any failures. This page explains how to use the execution panel and logs on the **Executions tab** to understand what happened during a workflow run. + +::::{admonition} Requirements +To use workflows, you must turn on the feature and ensure your role has the appropriate privileges. Refer to [](setup.md) to learn more. + +You must also have the appropriate subscription. Refer to the subscription page for [Elastic Cloud](https://www.elastic.co/subscriptions/cloud) and [Elastic Stack/self-managed](https://www.elastic.co/subscriptions) for the breakdown of available features and their associated subscription tiers. +:::: + +## Monitor execution [workflows-monitor-execution] + +When a workflow runs, the execution panel displays: + +- **Real-time logs**: Each step appears as it executes. +- **Status indicators**: Green indicates success and red represents failure. +- **Timestamps**: The duration of each step. +- **Expandable details**: Click any step to examine details such as input parameters, output data, and execution timelines. + +## View execution history [workflows-execution-history] + +To review past runs, select the **Executions** tab, then click each run to see detailed logs. Workflow runs can be `Pending`, `In progress`, `Completed`, or `Failed`. + +## Troubleshoot errors [workflows-troubleshoot-errors] + +When a workflow fails, open the failed execution from the **Executions** tab, then find the step with the error indicator. Expand the step to view the error message and to learn more about the root cause, such the input that caused the failure. After fixing an error, save the workflow before running it again. + +Common issues that can cause failures: + +| Issue | Cause | Solution | +|-------|-------|----------| +| Syntax error | Invalid YAML | Check indentation and formatting. | +| Step failed | Action error | Review step configuration and inputs. | +| Missing variable | Undefined reference | Verify variable names and data flow. | \ No newline at end of file