Skip to content

Commit d1b6f38

Browse files
committed
Start 'automations and integrations'
1 parent 451f0bf commit d1b6f38

File tree

6 files changed

+71
-4
lines changed

6 files changed

+71
-4
lines changed

docs/cloud-soar/introduction.md

Lines changed: 71 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -319,9 +319,7 @@ You can use Cloud SOAR to make downloadable reports, using the same information
319319

320320
## Introduction to Cloud SOAR for administrators
321321

322-
### SUMO Logic Cloud SOAR
323-
324-
#### What is Cloud SOAR administration?
322+
### What is Cloud SOAR administration?
325323

326324
Broadly speaking, Security Orchestration Automation and Response (SOAR) is a collection of scripts, APIs, playbooks, daemons, threat intelligence databases, dashboards, and other tools. As a Cloud SOAR administrator, you’ll be focusing on a few areas in particular:
327325
* **Role-based access controls**. Admins can create different roles and user groups with different levels of edit and view access to various areas within Cloud SOAR.
@@ -502,4 +500,73 @@ Grabbing an event assigns that event to the selected analyst, and any playbooks
502500

503501
To convert the event to an incident, click the three-dot kebab in the upper-right of the event and select **Convert To Incident**. Select the appropriate incident template, owner, and label, then click **Save**. The new incident will now be available in the **Incidents** screen along with any custom information gathered by playbooks run during triage.
504502

505-
<br/><img src={useBaseUrl('img/cloud-soar/reassign-discard-convert-event.png')} alt="Reassign or convert to incident" style={{border: '1px solid gray'}} width="600"/>
503+
<img src={useBaseUrl('img/cloud-soar/reassign-discard-convert-event.png')} alt="Reassign or convert to incident" style={{border: '1px solid gray'}} width="600"/>
504+
505+
### Automations and integrations
506+
507+
#### Why automate?
508+
509+
Automations are at the heart of Cloud SOAR. Playbooks, rules, and integrations all help you automate various tasks in your security operations center.
510+
511+
There are several reasons you might want to automate some security tasks:
512+
* **Faster responses**. Automating parts of your SOC can mean faster response times.
513+
* **Consolidate tools**. Orchestrate all your security tools in one location with integrations and custom APIs.
514+
* **Close the skills gap**. Analysts of all skill levels can deploy playbooks. Veteran analysts can spend more time on threat hunting.
515+
516+
Typically, each playbook in Sumo Logic Cloud SOAR will help automate or partially automate two or three of the steps of the incident response cycle.
517+
518+
<img src={useBaseUrl('img/cloud-soar/incident-response-cycle.png')} alt="Incident response cycle" style={{border: '1px solid gray'}} width="600"/>
519+
520+
#### Import and Configure an integration through App Central
521+
522+
Cloud SOAR comes with hundreds of pre-built playbooks and integrations as part of App Central.
523+
524+
As a Cloud SOAR administrator, you can explore App Central and install any integrations your team requests. You can also create custom integrations using APIs from the Integrations page. These integrations will connect Cloud SOAR to other tools like CrowdStrike, ServiceNow, or Jira. Once all your tools are integrated, Cloud SOAR can be a single, central location for orchestrating your security response.
525+
526+
Let's walk through how to install and configure useful integrations through App Central.
527+
528+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu select **Automation** and then and click **App Central** in the left navigation bar. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu select **Automation > App Central**. You can also click the **Go To...** menu at the top of the screen and select **App Central**.
529+
2. Click on the **Integrations** tab in the top tab row.<br/>The App Central integrations page shows a long list of installed and available integrations to augment Cloud SOAR functionality with both Sumo Logic and third-party vendor functionality.<br/><img src={useBaseUrl('img/cloud-soar/app-central-integrations-tab.png')} alt="App Central Integrations tab" style={{border: '1px solid gray'}} width="600"/>
530+
1. Choose a sample integration from the list and click on it. A popup window will appear showing the details of the integration, including version, description, and a list of actions that are supported in automations.
531+
1. Navigate to the **Integrations** view to show installed integrations.<br/>[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Automation** and then select **Integrations** in the left nav bar. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Automation > Integrations**. You can also click the **Go To...** menu at the top of the screen and select **Integrations**.<br/>In this view, you can see the integrations that have already been installed and configured in the system.
532+
1. Click an integration. The panel on the right will show the integration details, including available actions. Many integrations after install will require appropriate configuration using "resources".
533+
1. Move the mouse cursor over the resource, then click the **Edit** (pencil) icon.<br/><img src={useBaseUrl('img/cloud-soar/example-integration-resource.png')} alt="Example integration resource" style={{border: '1px solid gray'}} width="600"/>
534+
1. You will see a dialog showing the configuration fields for this resource. <br/>When you create a resource or configure an existing one, you will need to enter the appropriate connection information such as the API web URL (for either Sumo Logic or a third-party service) and associated API keys. Many Sumo Logic integrations will require you to create an [access key](/docs/manage/security/access-keys/) and supply an associated access ID and access key to use in configuring integrations. Some third party integrations may require you to visit their website and sign up for an account in order to obtain the appropriate URL and/or credentials for their API.<br/><img src={useBaseUrl('img/cloud-soar/example-edit-resource.png')} alt="Example edit resource" style={{border: '1px solid gray'}} width="400"/>
535+
1. Click the **Test** button after you have configured the resource to test the connection info. You will see a small popup that indicates whether the test was successful. (It may take a few seconds to execute depending on the integration.)
536+
537+
#### Playbooks
538+
539+
Once you’ve identified a potential security incident, you can respond to it in Cloud SOAR by executing a playbook. Playbooks are automated, or partially automated, workflows that act based on information from an incident. The playbook can enrich data, contain threats, notify teams, and other actions with custom APIs. These actions help automatically orchestrate many parts of the investigation, containment, eradication, and recovery processes.
540+
541+
Custom playbooks allow you to automate any task that uses a custom API. You can also use them to automate tasks that aren’t part of the hundreds of default playbooks included in Cloud SOAR.
542+
543+
Playbooks are made up of nodes which are connected together in a flowchart. Whether you’re customizing a playbook or creating one from scratch, you have several node options:
544+
* **Actions**. Enrich data, execute APIs, send notifications, or use other integrations.
545+
* **Tasks**. Assign a task to an analyst or another human for later review.
546+
* **Conditions**. If-then statements that allow playbooks to branch in different directions.
547+
* **User choice**. Pause the playbook and wait for a human’s decision.
548+
* **Embedded playbooks**. Run another playbook.
549+
550+
Each of these nodes are color-coded in a playbook:
551+
* A. **Conditions**. Conditions are represented by a purple diamond, allow your playbook to branch in different directions based on an if-then statement.
552+
* B. **Enrichments**. Green nodes are enrichments. These might add additional information from a threat intel database or convert data from one type to another.
553+
* C. **User Choice** User choices, represented by a red circle, pause a playbook and wait for a human's decision. After the choice is made, the playbook can continue branching in different directions.
554+
* D. **Containments**. Red nodes are containments. These can stop the spread of viruses and keep your data safe.
555+
* E. **Tasks**. Orange nodes assign tasks to a teammate in Cloud SOAR, such as manually reviewing data.
556+
* F. **Notifications**. Blue nodes are notification actions, such as a Slack or email alert.
557+
* G. **Custom**. Purple nodes are custom actions, such as APIs. <br/><img src={useBaseUrl('img/cloud-soar/playbook-nodes-example.png')} alt="Example playbook nodes" style={{border: '1px solid gray'}} width="700"/>
558+
559+
Action nodes use integrations. These integrations broadly fall into several types:
560+
* **Enrichments**. Add information, metadata, or context, such as from a threat intelligence database.
561+
* **Containment**. Reduces further damage by isolating files or machines related to a threat.
562+
* **Notifications**. Alerts sent via email, Slack, PagerDuty, or most other services you can connect with an API.
563+
* **Custom**. Scripts and any other automations you can create using YAML, Perl, Python, PowerShell, or Bash.
564+
* **Daemons**. Background processes that can ingest data.
565+
566+
Custom actions can also include trigger actions, which run based on an event type until certain criteria are met. For example, if malware is detected, a trigger action could run an anti-malware cleanup software until no malware is detected. Similarly, you can create scheduled actions that run at certain intervals. For example, you could create a scheduled action that checks for malicious IP addresses every 5 minutes until no more malicious IP addresses are found.
567+
568+
##### Best practices
569+
570+
Before you begin creating or customizing a playbook, decide what you’d like to automate. Think about what conditions you want met, and what actions or integrations you want to accomplish based on different flows. Once you have a design in mind for the flow of your playbook, you can create or customize a new one. Search App Central to see if an out-of-the-box playbook that does what you want already exists, or if you can modify a existing playbook that’s similar to what you have in mind.
571+
572+
103 KB
Loading
106 KB
Loading
244 KB
Loading
286 KB
Loading
104 KB
Loading

0 commit comments

Comments
 (0)