-
Notifications
You must be signed in to change notification settings - Fork 199
[Workflows][9.3 & Serverless] Merges all workflow docs #4758
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
## Workflows [9.3 & Serverless][Phase 1] Resolves #4658 ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Cursor, claude-4.5-opus-high Preview: <img width="269" height="692" alt="image" src="https://github.com/user-attachments/assets/75e1062f-57fe-4a7b-8c18-6727352c6b3f" />
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary Follow-up to #4709. This PR adds frontmatter to workflow pages. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [x] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: -->
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Created a section for templates and included a reference to https://github.com/elastic/workflows/. <img width="600" height="535" alt="Screenshot 2026-01-21 at 7 22 13 PM" src="https://github.com/user-attachments/assets/dbb26384-9986-48f0-98d0-c84bc6a86575" /> ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> Cursor, claude-4.5-opus-high
Vale Linting ResultsSummary: 1 warning, 9 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/workflows/templates.md | 17 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
💡 Suggestions (9)
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/workflows.md | 23 | Elastic.WordChoice | Consider using 'efficient, basic' instead of 'simple', unless the term is in the UI. |
| explore-analyze/workflows.md | 107 | Elastic.Repetition | "to" is repeated. |
| explore-analyze/workflows/data.md | 148 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| explore-analyze/workflows/data.md | 174 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| explore-analyze/workflows/data.md | 199 | Elastic.Wordiness | Consider using 'continue' instead of 'Continue on'. |
| explore-analyze/workflows/get-started.md | 157 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/workflows/setup.md | 35 | Elastic.Repetition | "to" is repeated. |
| explore-analyze/workflows/setup.md | 36 | Elastic.Repetition | "to" is repeated. |
| explore-analyze/workflows/steps.md | 57 | Elastic.Wordiness | Consider using 'also' instead of 'In addition'. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Fixes #4762: Adds docs for turning on workflows and granting role access to the feature. <img width="1472" height="957" alt="Screenshot 2026-01-22 at 1 47 02 PM" src="https://github.com/user-attachments/assets/9bffada1-8f92-406e-9957-55327c3599a7" /> ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> Cursor, claude-4.5-opus-high
## Workflows [9.3 & Serverless][Phase 1] Resolves #4652: documents the Triggers section and the Core components overview page. ## Previews * [Core components](https://697205794aca061660bbd0dc--pr-4696-preview.netlify.app/explore-analyze/workflows/core-components/) * [Triggers](https://697205794aca061660bbd0dc--pr-4696-preview.netlify.app/explore-analyze/workflows/triggers/) * [Manual triggers](https://697205794aca061660bbd0dc--pr-4696-preview.netlify.app/explore-analyze/workflows/triggers/manual-triggers/) * [Scheduled triggers](https://697205794aca061660bbd0dc--pr-4696-preview.netlify.app/explore-analyze/workflows/triggers/scheduled-triggers/) * [Alert triggers](https://697205794aca061660bbd0dc--pr-4696-preview.netlify.app/explore-analyze/workflows/triggers/alert-triggers/) To find these pages in the left nav, go to Elastic Docs > Explore and analyze > Workflows NOTE: * These previews are static deployments generated via netlify – they won't get auto-updated when new commits are pushed to the PR. * These previews are deployments of the Explore and analyze section – pages outside of this section are not available to preview. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Cursor, claude-4.5-opus-high
Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Fixes #4650: Adds introductory material, including an overview of workflows and a tutorial for getting started. ## Previews * [Workflows](https://69724b9b2b4de80f30c62781--pr-4696-preview.netlify.app/explore-analyze/workflows/) * [Get started with workflows](https://69724b9b2b4de80f30c62781--pr-4696-preview.netlify.app/explore-analyze/workflows/get-started/) To find these pages in the left nav, go to Elastic Docs > Explore and analyze > Workflows NOTE: * These previews are static deployments generated via netlify – they won't get auto-updated when new commits are pushed to the PR. * These previews are deployments of the Explore and analyze section – pages outside of this section are not available to preview. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> Tool(s) and model(s) used: Cursor, claude-4.5-opus-high --------- Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Fixes #4654. - The "Data and error handling" page covers the general flow of data through workflows, error handling, and how to insert dynamic values with templating. - The "Templating engine" page covers what the workflow templating engine is. It describes templating engine syntax, provides examples of how to apply templates, and explains how templates process data structures, nested objects, and arrays. ## Previews * [Data and error handling](https://697246913eb003e52c9e09cd--pr-4696-preview.netlify.app/explore-analyze/workflows/data/) * [Templating engine](https://697246913eb003e52c9e09cd--pr-4696-preview.netlify.app/explore-analyze/workflows/data/templating/) To find these pages in the left nav, go to Elastic Docs > Explore and analyze > Workflows NOTE: * These previews are static deployments generated via netlify – they won't get auto-updated when new commits are pushed to the PR. * These previews are deployments of the Explore and analyze section – pages outside of this section are not available to preview. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> Cursor, claude-4.5-opus-high --------- Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com> Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary Fixes the following issues: - #4651: Describes the YAML editor interface, which you use to create, run, and validate workflows. - #4656: Describes how to monitor executed workflows and troubleshoot failures. - #4655: Explains how to manage workflows from the **Workflows** page. ## Previews * [Author workflows](https://69724941383e8dedebb0e0e7--pr-4696-preview.netlify.app/explore-analyze/workflows/author-workflows/) * [Monitor and troubleshoot workflows](https://69724941383e8dedebb0e0e7--pr-4696-preview.netlify.app/explore-analyze/workflows/monitor-troubleshoot/) * [Manage workflows](https://69724941383e8dedebb0e0e7--pr-4696-preview.netlify.app/explore-analyze/workflows/manage-workflows/) To find these pages in the left nav, go to Elastic Docs > Explore and analyze > Workflows NOTE: * These previews are static deployments generated via netlify – they won't get auto-updated when new commits are pushed to the PR. * These previews are deployments of the Explore and analyze section – pages outside of this section are not available to preview. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> Cursor, claude-4.5-opus-high
| with: | ||
| message: |- | ||
| Found {{ steps.search_park_data.output.hits.total.value }} parks in category "canyon". | ||
| Top results: {{ steps.search_park_data.output.hits.hits | json(2) }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following validation warning was returned for the {{ steps.search_park_data.output.hits.total.value }} variable:
Variable steps.search_park_data.output.hits.total.value cannot be validated, because it's type is unknownvariable-validation
(property) steps.search_park_data.output.hits.total.value:
unknown
As per this comment by @jamesspi this can be doc'd as a known issue and is safe to ignore for 9.3. @florent-leborgne I'm considering adding this known issue to the Kibana release notes for visibility -- sans a link to a GH issue since I'm not sure if there's one atm. Let me know if you think it's more appropriate to include in the feature docs instead or in both places.
| - name: process-item | ||
| type: console | ||
| with: | ||
| message: "{{foreach.item._source.name}}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following validation warning was returned for the {{foreach.item._source.name}} variable:
Variable foreach.item._source.name cannot be validated, because it's type is unknownvariable-validation
(property) foreach.item._source.name:
unknown // Expected array for foreach iteration, but got unknown (unknown)
As per @jamesspi's comment, it's safe to ignore for 9.3. Same question about release notes @florent-leborgne.
## Workflows [9.3 & Serverless][Phase 1] Contributes to #4653: Documents the flow control steps overview and the pages for each flow control step type ## Previews * [Flow control steps](https://697385a70f0626825e3c43ab--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/flow-control-steps/) * [If](https://697385a70f0626825e3c43ab--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/if/) * [Foreach](https://697385a70f0626825e3c43ab--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/foreach/) * [Wait](https://697385a70f0626825e3c43ab--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/wait/) To find these pages in the left nav, go to Elastic Docs > Explore and analyze > Workflows NOTE: * These previews are static deployments generated via netlify – they won't get auto-updated when new commits are pushed to the PR. * These previews are deployments of the Explore and analyze section – pages outside of this section are not available to preview. ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Cursor, claude-4.5-opus-high
## Workflows [9.3 & Serverless][Phase 1] Contributes to #4653: Documents the steps overview page, the action steps page, and the pages for the action step categories (Elasticsearch, Kibana, external systems) ## Previews * [Steps](https://697240d0ab31a4d1b33d6251--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/) * [Action steps](https://697240d0ab31a4d1b33d6251--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/action-steps/) * [Elasticsearch action steps](https://697240d0ab31a4d1b33d6251--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/elasticsearch/) * [Kibana action steps](https://697240d0ab31a4d1b33d6251--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/kibana/) * [External systems and apps steps](https://697240d0ab31a4d1b33d6251--pr-4696-preview.netlify.app/explore-analyze/workflows/steps/external-systems-apps/) To find these pages in the left nav, go to Elastic Docs > Explore and analyze > Workflows NOTE: * These previews are static deployments generated via netlify – they won't get auto-updated when new commits are pushed to the PR. * These previews are deployments of the Explore and analyze section – pages outside of this section are not available to preview. ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Cursor, claude-4.5-opus-high
|
|
||
| ```yaml | ||
| - name: bulk_index_park_data | ||
| type: elasticsearch.bulk |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Post-9.3) We should verify if both this example and the elasticsearch.bulk example in elasticsearch.md are correct, since their syntax after the index parameter doesn't match.
|
|
||
| Refer to [](/explore-analyze/workflows/steps/flow-control-steps.md) for more information. | ||
|
|
||
| ## AI steps |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could probably be a bit more concrete, I don't have the time to properly address this right now, but here's some ideas.
There are various steps to simplify interacting with actions and services that use AI, including Elastic Agent Builder.
For example:
- You can use the
ai.agentstep to call a built-in or custom Elastic AI agent- There are various steps for common tasks using the AI connector. For example, use
ai.promptto send a prompt to an AI connector.- There are steps for working with popular LLM providers such as OpenAI, Gemini etc.
Elastic Agent Builder integration
In addition to calling your Elastic AI agents from within your workflows, your AI agents built with Elastic Agent Builder can also trigger workflows. To enable this, you must create a custom workflow tool type and assign it to an agent. The agent can then trigger the workflow from a conversation.
Learn more:
- Working with agents within workflows
- Custom workflow tools in Elastic Agent Builder
bmorelli25
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving to unblock.
Summary
Fixes #4647: merges all workflow docs for 9.3 and the serverless release happening the week of Jan 27th.
Note: Docs for the advanced setting are published here. The
applies_totag indicates that the advanced setting is available in tech preview for Serverless and 9.3.Generative AI disclosure