Skip to content

Commit 914ebbb

Browse files
jpipkin1kimsauce
andauthored
DOCS-1165 - Out-of-the-box playbooks (#5858)
* Rough draft * Finish draft * Fix broken links * Update docs/platform-services/automation-service/playbooks-in-app-central.md Co-authored-by: Kim (Sumo Logic) <[email protected]> --------- Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent b904853 commit 914ebbb

File tree

6 files changed

+38
-24
lines changed

6 files changed

+38
-24
lines changed

docs/platform-services/automation-service/automation-service-app-central.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Before you can access App Central, you must have the App Central Access role cap
3030
:::note
3131
<ActionsLimit/>
3232
:::
33-
1. **Install**. Click to [install an integration](#install-an-integration-from-app-central) or [install a playbook](/docs/platform-services/automation-service/playbooks-in-app-central/#install-a-playbook-from-app-central).
33+
1. **Install**. Click to [install an integration](#install-an-integration-from-app-central) or [install a playbook](/docs/platform-services/automation-service/playbooks-in-app-central/#install-an-out-of-the-box-playbook-from-app-central).
3434

3535
## Work with integrations in App Central
3636

docs/platform-services/automation-service/playbooks-in-app-central.md

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,57 @@
11
---
22
id: playbooks-in-app-central
3-
title: Playbooks in App Central
4-
sidebar_label: Playbooks in App Central
3+
title: Out-of-the-Box Playbooks in App Central
4+
sidebar_label: Out-of-the-Box Playbooks
55
description: Learn about the out-of-the-box playbooks available in App Central.
66
---
77

88
import useBaseUrl from '@docusaurus/useBaseUrl';
99
import SamplePlaybooks from '../../reuse/automation-service/sample-playbooks.md';
1010

11-
A playbook is a predefined set of actions and conditional statements that run in an automated workflow to respond to a certain event or incident type.
11+
A playbook is a predefined set of actions and conditional statements that run in an automated workflow to respond to a certain event or incident type. Sumo Logic provides hundreds of out-of-the-box playbooks in the **Playbooks** tab of [App Central](/docs/platform-services/automation-service/automation-service-app-central/). These out-of-the-box playbooks can handle many different situations, such as phishing attempts, brute force attacks, ransomware, and many others.
1212

13-
While [playbooks](/docs/platform-services/automation-service/playbooks/) in the Automation Service UI show the playbooks installed to your environment, the **Playbooks** tab in App Central shows you additional playbooks you can install.
13+
The out-of-the-box playbooks are templates that you need to configure before they will work in your environment. Look through the playbooks to find ones that could help you. Once you've identified one you'd like to use, follow these steps:
14+
1. [Install the playbook](#install-an-out-of-the-box-playbook-from-app-central).
15+
1. [Configure the installed out-of-the-box playbook](#configure-an-out-of-the-box-playbook) to run actions in the integrations you have in your environment.
16+
:::note IMPORTANT
17+
You must first [install integrations](/docs/platform-services/automation-service/automation-service-app-central/#install-an-integration-from-app-central) and [configure authentication for them](/docs/platform-services/automation-service/configure-authentication-for-integrations/) before you can configure playbooks to use the actions from those integrations.
18+
:::
1419

15-
### Install a playbook from App Central
20+
## Install an out-of-the-box playbook from App Central
1621

1722
1. Use the **Search** bar in the upper right of the **Playbooks** tab to find playbooks.
1823
1. Click **Install** in the corner of the playbook box.
1924
1. Click **Next**.
2025
1. Click **Install** to install the playbook.
2126
1. Click **Close**. After installation is complete, **Installed** replaces the **Install** link in the corner of the playbook box.
22-
1. **IMPORTANT**: Click **Show More** in the playbook box to see if there are additional steps you need to follow to configure the installed playbook. Failure to perform these additional steps may result in the playbook not working properly.
23-
24-
<!-- There used to be an export button, but now it's gone. Saving this text below in case it comes back.
25-
26-
## Export from App Central
27-
28-
You can export the contents of integrations and playbooks from App Central.
29-
30-
1. Click the **Go to export page** button in the top right corner of the **Integrations** tab.<br/><img src={useBaseUrl('img/cse/automation-service-app-central-export-button.png')} alt="Go to the export page" style={{border: '1px solid gray'}} width="300"/>
31-
1. Select the items you want to export. Provide a description in the box provided. If you select more than one item, you are prompted to provide a title as well.
32-
1. Scroll down and click **Export** at the bottom right corner of the screen. The selections are exported in a .tar file to your downloads folder.
33-
1. Extract the .tar file. An archive file is extracted from the .tar file (for example, a .tar.gz file).
34-
1. Extract the archive file. The exported items are extracted, including any YAML files they contain.
35-
36-
-->
27+
1. Click **Show More** in the playbook box to see if there are additional steps you need to follow to configure the installed playbook. Failure to perform these additional steps may result in the playbook not working properly.
28+
29+
## Configure an out-of-the-box playbook
30+
31+
After you install an out-of-the-box playbook from App Central, it appears on the [**Playbooks**](/docs/platform-services/automation-service/playbooks/create-playbooks/#view-playbooks) list. Perform the following steps to configure the out-of-the-box playbook.
32+
33+
1. Select the playbook from the list. In the example below, the *21 - DLP Alert* playbook is selected. <br/><img src={useBaseUrl('img/platform-services/automation-service/example-out-of-the-box-playbook.png')} alt="Example out-of-the-box playbook" style={{border: '1px solid gray'}} width="700" />
34+
1. Click the edit button at the bottom of the screen.
35+
1. Hover your mouse over a node and click the edit button that appears on the node. The **Edit Node** dialog appears.
36+
1. Note the **Node name**. It should tell you what action you need to connect to. In the following example, the node name is *IP reputation destination address with VirusTotal*. That tells us we need to connect to the *IP Reputation* action in the [VirusTotal integration](/docs/platform-services/automation-service/app-central/integrations/virustotal/) and use the *destination address*.<br/><img src={useBaseUrl('img/platform-services/automation-service/example-out-of-the-box-playbook-2.png')} alt="Example out-of-the-box playbook node" style={{border: '1px solid gray'}} width="400" />
37+
1. In the **Integration** field, select the integration. (In our example, select **VirusTotal**.)
38+
:::note IMPORTANT
39+
You must have [already installed the integration](/docs/platform-services/automation-service/automation-service-app-central/#install-an-integration-from-app-central) and [configured its authentication](/docs/platform-services/automation-service/configure-authentication-for-integrations/) before you can use actions in the integration.
40+
:::
41+
1. In the **Action** field, select the action. (In our example, select **IP Reputation**.)
42+
1. Fill out other fields as needed. Fields with asterisks are required. (In our example, in the **IP** field select **destinationAddress**).<br/><img src={useBaseUrl('img/platform-services/automation-service/example-out-of-the-box-playbook-3.png')} alt="Example out-of-the-box playbook node with integration and action selected" style={{border: '1px solid gray'}} width="400" />
43+
1. After you're done configuring the node, toggle **Test Mode** at the top of the dialog to [test the node](/docs/platform-services/automation-service/playbooks/troubleshoot-playbooks/#test-nodes-in-a-playbook).
44+
1. After you are sure the node works as expected, click **Save**.
45+
1. Continue configuring nodes until you have configured all the nodes in the playbook.
46+
1. When done configuring nodes, [test the playbook](/docs/platform-services/automation-service/playbooks/troubleshoot-playbooks/#test-a-playbook) to make sure it works as expected.
47+
48+
:::note ADVISORY
49+
The out-of-the-box playbooks are merely templates to guide you, and the integrations indicated in their node names may not exist in your environment. Edit the playbook to connect to integrations that you have installed and configured, and change the playbooks as needed.
50+
:::
3751

3852
## Playbooks in App Central
3953

40-
This section lists all the out-of-the-box playbooks you can install.
54+
This section lists all the out-of-the-box playbooks you can install from App Central.
4155

4256
### 1 - Basic IP Reputation
4357

docs/platform-services/automation-service/playbooks/create-playbooks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ import CartesianProduct from '../../../reuse/cartesian-product.md';
1010

1111
## View playbooks
1212

13-
The following procedure describes how to view playbooks already installed in your environment. To add more playbooks, [create a playbook](#create-a-new-playbook), or [install a playbook from App Central](/docs/platform-services/automation-service/playbooks-in-app-central/#install-a-playbook-from-app-central).
13+
The following procedure describes how to view playbooks already installed in your environment. To add more playbooks, [create a playbook](#create-a-new-playbook), or [install a playbook from App Central](/docs/platform-services/automation-service/playbooks-in-app-central/#install-an-out-of-the-box-playbook-from-app-central).
1414

1515
1. [**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Automation > Playbooks**. You can also click the **Go To...** menu at the top of the screen and select **Playbooks**. <br/>The list of playbooks displays. <br/>[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Automation > Playbooks**. <br/> <img src={useBaseUrl('img/cse/automations-playbook-list.png')} alt="Automation Playbook list" style={{border:'1px solid gray'}} width="700"/>
1616
1. Select a playbook to see the elements in the workflow.<br/><img src={useBaseUrl('img/cse/automations-open-playbook.png')} style={{border:'1px solid gray'}} alt="Opened playbook" width="700"/>
1717
1. Click the elements in the playbook to see their details. For example, click actions (the boxes in the flow) to see the [integration](/docs/platform-services/automation-service/automation-service-integrations/) resources that provide the actions.<br/><img src={useBaseUrl('img/cse/automations-action-example.png')} style={{border:'1px solid gray'}} alt="Action example" width="700"/>
1818

1919
## Create a new playbook
2020

21-
Before you create your own playbook, first [view playbooks](#view-playbooks) to make sure there isn't one already that does what you want to accomplish, and also check to see if you can [install a playbook from App Central](/docs/platform-services/automation-service/playbooks-in-app-central/#install-a-playbook-from-app-central) that does what you need. After you create a playbook, you can run it in automations for [monitors](/docs/alerts/monitors/use-playbooks-with-monitors/), [Cloud SIEM](/docs/cse/automation/automations-in-cloud-siem/), or [Cloud SOAR](/docs/cloud-soar/automation/).
21+
Before you create your own playbook, first [view playbooks](#view-playbooks) to make sure there isn't one already that does what you want to accomplish, and also check to see if you can [install a playbook from App Central](/docs/platform-services/automation-service/playbooks-in-app-central/#install-an-out-of-the-box-playbook-from-app-central) that does what you need. After you create a playbook, you can run it in automations for [monitors](/docs/alerts/monitors/use-playbooks-with-monitors/), [Cloud SIEM](/docs/cse/automation/automations-in-cloud-siem/), or [Cloud SOAR](/docs/cloud-soar/automation/).
2222

2323
:::tip
2424
The following procedure provides a brief introduction to how to create a playbook. For detailed examples of how to create playbooks, see the [Cloud SIEM automation examples](/docs/cse/automation/cloud-siem-automation-examples/).
90.1 KB
Loading
139 KB
Loading
474 KB
Loading

0 commit comments

Comments
 (0)