-
Notifications
You must be signed in to change notification settings - Fork 200
[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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
1c5d775
Adds TOC (#4709)
natasha-moore-elastic 14a69bc
Adds front matter to workflow pages (#4711)
nastasha-solomon c2ebdb7
Merge main into workflows-9.3
natasha-moore-elastic 2ed838b
[Workflows] Adds template section (#4742)
nastasha-solomon 86b978f
[Workflows]: Admin capabilities for workflows (#4763)
nastasha-solomon 24ae607
Update explore-analyze/toc.yml
nastasha-solomon b7be496
Merge branch 'main' into workflows-9.3
natasha-moore-elastic d3df856
Update explore-analyze/workflows/setup.md
nastasha-solomon 9efcaf0
Add related links
nastasha-solomon b35fd80
[Workflows] Core components - triggers (#4696)
natasha-moore-elastic e8e32e1
Update explore-analyze/workflows/setup.md
natasha-moore-elastic dede82f
Update explore-analyze/workflows/setup.md
nastasha-solomon 7304322
Update explore-analyze/workflows/triggers.md
natasha-moore-elastic f9529b1
revised setup intro
nastasha-solomon ca59f15
[Workflows] Introductory material and foundational concepts (#4713)
nastasha-solomon 96f1c55
[Workflows] Data and error handling (#4716)
nastasha-solomon 1d4846a
Merge branch 'main' into workflows-9.3
nastasha-solomon 10b14d0
Update explore-analyze/workflows.md
nastasha-solomon cb01c7d
[Workflows] Authoring, monitoring/troubleshooting, and managing (#4718)
nastasha-solomon f4a3e7a
uncomment links and remove extra file
nastasha-solomon 19b20b7
addresses some style issues
nastasha-solomon 9135c5c
[Workflows] Flow control steps (#4759)
natasha-moore-elastic 0e07299
[Workflows] Action steps (#4751)
natasha-moore-elastic 1cf99fd
Merge branch 'main' into workflows-9.3
natasha-moore-elastic 74cc08a
add links and remove comments
natasha-moore-elastic 00470f3
Update explore-analyze/workflows.md
natasha-moore-elastic f46a9f9
expand AI steps
natasha-moore-elastic 03a373b
Merge branch 'main' into workflows-9.3
natasha-moore-elastic b181f36
add link
natasha-moore-elastic 874ab20
Merge branch 'main' into workflows-9.3
nastasha-solomon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Workflows |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn about the core components that make up Elastic workflows. | ||
| --- | ||
|
|
||
| # Core components |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn how to create and execute Elastic workflows. | ||
| --- | ||
|
|
||
| # Create and run workflows | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn how data is processed and transformed in Elastic workflows. | ||
| --- | ||
|
|
||
| # Data |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn how to get started creating Elastic workflows. | ||
| --- | ||
|
|
||
| # Get started with Workflows |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn how to edit and manage existing Elastic workflows. | ||
| --- | ||
|
|
||
| # Manage workflows |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn how to monitor Elastic workflows executions and troubleshoot errors. | ||
| --- | ||
|
|
||
| # Monitor and troubleshoot workflows |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn how to enable workflows and configure role-based access. | ||
| --- | ||
|
|
||
| # Set up workflows [workflows-setup] | ||
|
|
||
| Before you can use workflows, you need to turn on the feature and ensure users have the appropriate permissions. In addition, you must 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. | ||
|
|
||
| ## Enable workflows [workflows-enable] | ||
|
|
||
| The workflows feature is turned off by default. To turn it on: | ||
|
|
||
| 1. Go to the **Advanced Settings** management page in the navigation menu or using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). | ||
| 2. Search for `workflows:ui:enabled`. | ||
| 3. Toggle the setting on. | ||
| 4. Click **Save changes** to turn on workflows in your space, then reload the page. | ||
|
|
||
| The **Workflows** page displays in the main navigation menu and you can search for it using the global search field. | ||
|
|
||
| ## Manage access to workflows [workflows-role-access] | ||
|
|
||
| Access to workflows is controlled by [{{kib}} privileges](/deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md). Ensure users have the appropriate roles assigned to create, edit, run, and manage workflows. | ||
|
|
||
| | Action | Required privilege | | ||
| |--------|-------------------| | ||
| | Access the **Workflows** page | `All` or `Read` for **Analytics > Workflows** | | ||
| | Fully manage workflows | `All` for **Analytics > Workflows** | | ||
| | Grant access to specific workflow actions | Set sub-feature privileges for **Analytics > Workflows** | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn about workflow steps and how to create and configure them. | ||
| --- | ||
|
|
||
| # Steps |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Explore pre-built workflow templates to jumpstart your automation. | ||
| --- | ||
|
|
||
| # Workflow templates [workflows-templates] | ||
|
|
||
| Workflow templates are pre-built workflows that you can use as a starting point. Instead of building automations from scratch, pick a template and customize it to fit your needs. For example, templates are useful for: | ||
| - Automating a common task | ||
| - Learning how workflows work | ||
| - Saving time with a ready-made example of a common automation pattern | ||
|
|
||
| ## Access templates [workflows-templates-access] | ||
|
|
||
| [Browse](https://github.com/elastic/workflows/) available templates and examples to find one that matches your use case. Refer to the readme to get started using templates. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn about workflow triggers and how to create and configure them. | ||
| --- | ||
|
|
||
| # Triggers |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Understand alert triggers and how to create and configure them. | ||
| --- | ||
|
|
||
| # Alert triggers |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Understand manual triggers and how to create and configure them. | ||
| --- | ||
|
|
||
| # Manual triggers |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Understand scheduled triggers and how to create and configure them. | ||
| --- | ||
|
|
||
| # Scheduled triggers |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| applies_to: | ||
| stack: preview 9.3 | ||
| serverless: preview | ||
| description: Learn about common workflow usecases for search, observability, and security. | ||
| --- | ||
|
|
||
| # Use cases |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.