Skip to content

Commit 4a020d9

Browse files
jpipkin1kimsauce
andauthored
DOCS-825 - Out-of-the-box playbooks (#5564)
* Rough draft * Playbooks 0-100 * 100-200 playbooks * 200-300 playbooks * 300-400 playbooks * 400-440 playbooks * Last playbooks * Fix broken links * Fix another broken link * Add 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 b34cc7e commit 4a020d9

File tree

6 files changed

+3886
-31
lines changed

6 files changed

+3886
-31
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ In this section, we'll introduce the following concepts:
1818
<p>Learn how to use App Central to get new applications and tools.</p>
1919
</div>
2020
</div>
21+
<div className="box smallbox card">
22+
<div className="container">
23+
<a href="/docs/platform-services/automation-service/playbooks-in-app-central/"><img src={useBaseUrl('img/icons/security/siem-challenges.png')} alt="icon" width="40"/><h4>Playbooks in App Central</h4></a>
24+
<p>Learn about the available playbooks in App Central.</p>
25+
</div>
26+
</div>
2127
<div className="box smallbox card">
2228
<div className="container">
2329
<a href="/docs/platform-services/automation-service/configure-authentication-for-integrations/"><img src={useBaseUrl('img/icons/security/siem-challenges.png')} alt="icon" width="40"/><h4>Configure Authentication for Integrations</h4></a>

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

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ Before you can access App Central, you must have the App Central Access role cap
2323

2424
<img src={useBaseUrl('img/cse/automation-service-app-central.png')} alt="App Central" style={{border:'1px solid gray'}} width="800"/>
2525

26-
1. **Playbooks**. Click to view [playbooks in App Central](#playbooks-in-app-central) that are available to install.
26+
1. **Playbooks**. Click to view [playbooks in App Central](/docs/platform-services/automation-service/playbooks-in-app-central/) that are available to install.
2727
1. **Integrations**. Click to view [integrations in App Central](/docs/platform-services/automation-service/app-central/integrations/) that are available to install.
2828
1. **Search**. Search for integrations or playbooks to install.
2929
1. **Current hour actions count**. Shows how many playbook actions have been executed in the current hour in your organization.
3030
:::note
3131
<ActionsLimit/>
3232
:::
33-
1. **Install**. Click to [install an integration](#install-an-integration-from-app-central) or [install a playbook](#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-a-playbook-from-app-central).
3434

3535
## Work with integrations in App Central
3636

@@ -90,29 +90,4 @@ Sumo Logic will validate the integration, and work with you to make any updates
9090

9191
## Playbooks in App Central
9292

93-
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.
94-
95-
While [Playbooks](/docs/platform-services/automation-service/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.
96-
97-
### Install a playbook from App Central
98-
99-
1. Use the **Search** bar in the upper right of the **Playbooks** tab to find playbooks.
100-
1. Click **Install** in the corner of the playbook box.
101-
1. Click **Next**.
102-
1. Click **Install** to install the playbook.
103-
1. Click **Close**. After installation is complete, **Installed** replaces the **Install** link in the corner of the playbook box.
104-
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.
105-
106-
<!-- There used to be an export button, but now it's gone. Saving this text below in case it comes back.
107-
108-
## Export from App Central
109-
110-
You can export the contents of integrations and playbooks from App Central.
111-
112-
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"/>
113-
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.
114-
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.
115-
1. Extract the .tar file. An archive file is extracted from the .tar file (for example, a .tar.gz file).
116-
1. Extract the archive file. The exported items are extracted, including any YAML files they contain.
117-
118-
-->
93+
To work with playbooks in App Central, see [Playbooks in App Central](/docs/platform-services/automation-service/playbooks-in-app-central/).

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ A playbook is a predefined set of actions and conditional statements that run in
1313

1414
Playbooks can be configured to execute automatically without user intervention, acting on information from the incident, or can be executed in interactive mode, where user input is required to authorize predefined actions.
1515

16-
To run a playbook, add it to an automation. You can run playbooks in [monitors](/docs/alerts/monitors/use-playbooks-with-monitors/), [Cloud SIEM](/docs/cse/automation/automations-in-cloud-siem/), and [Cloud SOAR](/docs/cloud-soar/automation/#run-playbooks-in-cloud-soar).
16+
To run a playbook, add it to an automation. You can run playbooks in [monitors](/docs/alerts/monitors/use-playbooks-with-monitors/), [Cloud SIEM](/docs/cse/automation/automations-in-cloud-siem/), and [Cloud SOAR](/docs/cloud-soar/automation/#run-playbooks-in-cloud-soar). Sumo Logic provides a number of out-of-the-box playbooks that you can use install to use your automations. See [Playbooks in App Central](/docs/platform-services/automation-service/playbooks-in-app-central/).
1717

1818
:::note
1919
<ActionsLimit/>
2020
:::
2121

2222
## View playbooks
2323

24-
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/automation-service-app-central/#install-a-playbook-from-app-central).
24+
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).
2525

2626
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Automation > Playbooks**. <br/>[**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/> <img src={useBaseUrl('img/cse/automations-playbook-list.png')} alt="Automation Playbook list" style={{border:'1px solid gray'}} width="700"/>
2727
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"/>
2828
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"/>
2929

3030
## Create a new playbook
3131

32-
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/automation-service-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/).
32+
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/).
3333

3434
:::tip
3535
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/).

0 commit comments

Comments
 (0)