Set up Workflows
To use workflows, ensure your role has the appropriate privileges. You must also have the appropriate subscription. Refer to the subscription page for Elastic Cloud and Elastic Stack/self-managed for the breakdown of available features and their associated subscription tiers.
To use workflows, you must turn on the feature and ensure your role has the appropriate privileges. You must also have the appropriate subscription. Refer to the subscription page for Elastic Cloud and Elastic Stack/self-managed for the breakdown of available features and their associated subscription tiers.
The workflows feature is turned off by default. To turn it on:
- Go to the Advanced Settings management page in the navigation menu or using the global search field.
- Search for
workflows:ui:enabled. - Toggle the setting on.
- 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.
Access to workflows is controlled by Kibana privileges. The following table describes privileges required 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 |
The Template library is turned off by default and must be enabled by an administrator. If you don't see Template library in the Workflows navigation, ask an administrator to turn it on.
An administrator can enable the Template library by adding the following to kibana.yml, then restarting Kibana:
uiSettings.globalOverrides:
workflowsManagement:library:enabled: true
Have an administrator run the following request from Dev Tools to enable the Template library. This is a global setting, so it applies to your entire project, in all spaces:
POST kbn:/internal/kibana/global_settings
{
"changes": {
"workflowsManagement:library:enabled": true
}
}
The /internal/kibana/global_settings endpoint is an internal API and might change without notice. There is currently no public equivalent.
After the Template library is enabled, reload the Workflows page. It can take a few minutes and several reloads before Template library appears in the navigation.
- Create and run your first workflow. Refer to Build your first workflow to learn more.
- Understand how to use the YAML editor in Kibana to define and run workflows. Refer to Use the YAML editor to learn more.