-
Notifications
You must be signed in to change notification settings - Fork 228
Vectra C2C docs #5546
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
Vectra C2C docs #5546
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
b416dd2
Vectra C2C docs
JV0812 60b0770
Merge branch 'main' into vectra-source
jpipkin1 5cc70db
Merge branch 'main' into vectra-source
priyansh-sumo f549763
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 b7982c5
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 4689347
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 9124ceb
Merge branch 'main' into vectra-source
priyansh-sumo 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| title: Vectra Source (Collection) | ||
| image: https://help.sumologic.com/img/sumo-square.png | ||
| keywords: | ||
| - c2c | ||
| - vectra-source | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| We're excited to announce the release of our new cloud-to-cloud source for Vectra. This source aims to collect the threat detections from the Vectra platform and send them to Sumo Logic for streamlined analysis. [Learn more](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/vectra-source). |
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
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
87 changes: 87 additions & 0 deletions
87
...nd-data/hosted-collectors/cloud-to-cloud-integration-framework/vectra-source.md
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,87 @@ | ||
| --- | ||
| id: vectra-source | ||
| title: Vectra Source | ||
| sidebar_label: Vectra | ||
| tags: | ||
| - cloud-to-cloud | ||
| - vectra | ||
| description: Learn how to collect the list of threats detected in the Vectra platform. | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/platform-services/automation-service/app-central/logos/vectra.png')} alt="Vectra-icon" width="70" /> | ||
|
|
||
| Vectra is a leading cybersecurity company specialising in AI-driven threat detection and response solutions. Vectra is committed to helping organisations protect their digital assets from evolving cyber threats. It provides comprehensive visibility across the entire network, enabling organisations to identify malicious activities, including insider threats and advanced persistent threats (APTs). | ||
|
|
||
| ## Data collected | ||
|
|
||
| | Polling Interval | Data | | ||
| | :--- | :--- | | ||
| | 5 min | [Threat Detections](https://vectranetworks.my.salesforce.com/sfc/p/#i0000000HOyr/a/Rg00000528gW/UZpXGNk2iGlooWdyT5HpB3eOX39csgrXRdjzKaKpJVY) | | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| The Vectra source requires you to provide the Client ID and Client Secret. Refer to the [API Clients section in the Vectra Documentation](https://vectranetworks.my.salesforce.com/sfc/p/#i0000000HOyr/a/Rg00000528gW/UZpXGNk2iGlooWdyT5HpB3eOX39csgrXRdjzKaKpJVY). | ||
|
|
||
| ### Source configuration | ||
|
|
||
| When you create a Vectra Source, you add it to a Hosted Collector. Before creating the source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see [Configure a Hosted Collector and Source](/docs/send-data/hosted-collectors/configure-hosted-collector). | ||
|
|
||
| To configure a Vectra Source, follow the steps below: | ||
| 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. | ||
| 1. On the Collection page, click **Add Source** next to a Hosted Collector. | ||
| 1. Search for and select **Vectra**. | ||
| 1. Enter a **Name** for the Source. The description is optional. | ||
| 1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called `_sourceCategory`. | ||
| 1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value. | ||
| *  A green circle with a check mark is shown when the field exists in the Fields table schema. | ||
| *  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped. | ||
| 1. **Account URL**. Enter the account URL value `https://{vectra_portal_url}/api/v3.3/detections`. Replace `vectra_portal_url` with your subdomain value. For example, `https://308714519558.cc1.portal.vectra.ai`. | ||
| 1. **Client ID**. Enter the client ID value collected from the [Vectra platform](#vendor-configuration). | ||
| 1. **Client Secret**. Enter the client secret value collected from the [Vectra platform](#vendor-configuration). | ||
| 1. The **Polling Interval** is set for 5 minutes by default. You can adjust it based on your needs. This sets how often the Source checks for new data. | ||
| 1. When you are finished configuring the Source, click **Save**. | ||
|
|
||
| ## JSON schema | ||
|
|
||
| Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [How to Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for more details. | ||
|
|
||
| | Parameter | Type | Value | Required | Description | | ||
| |:--|:--|:--|:--|:--| | ||
| | schemaRef | JSON Object | `{"type":"Vectra"}` | Yes | Define the specific schema type. | | ||
| | sourceType | String | `"Universal"` | Yes | Type of source. | | ||
| | config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | | ||
|
|
||
| ### Configuration Object | ||
|
|
||
| | Parameter | Type | Required | Default | Description | Example | | ||
| |:--|:--|:--|:--|:--|:--| | ||
| | name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` | | ||
| | description | String | No | `null` | Type a description of the source. | `"Testing source"` | ||
| | category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"` | ||
| | fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}` | | ||
| | accountURL | String | Yes | `null` | Vectra account URL of your portal. For example,`https://308714519558.cc1.portal.vectra.ai`. | | | ||
JV0812 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | clientId | String | Yes | `null` | Client ID of the account. | | | ||
| | clientSecret | String | Yes | `null` | Client Secret of the account. | | | ||
| | pollingInterval | Integer | No | `5 minutes` | Choose how often the Source checks for new data (In minutes).<br/>Default: 5 minutes <br/>Minimum: 5 minutes <br/>Maximum: 60 minutes | | | ||
JV0812 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### JSON example | ||
|
|
||
| ```json reference | ||
| https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/vectra/example.json | ||
| ``` | ||
|
|
||
| ### Terraform example | ||
|
|
||
| ```sh reference | ||
| https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/vectra/example.tf | ||
| ``` | ||
JV0812 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## FAQ | ||
|
|
||
| :::info | ||
| Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. | ||
| ::: | ||
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,16 @@ | ||
| { | ||
| "api.version": "v1", | ||
| "source": { | ||
| "config": { | ||
| "name": "Vectra", | ||
| "accountURL": "https://123456789012.cc1.portal.vectra.ai", | ||
| "clientId": "8e09xxxxxxxxxxxx36x2d2", | ||
| "clientSecret": "q3Wxxxxxxxxxxxxxxpy4W5MhxJ4xxsRD63hdf", | ||
| "pollingIntervalMin": "5m" | ||
| }, | ||
| "schemaRef": { | ||
| "type": "Vectra" | ||
| }, | ||
| "sourceType": "Universal" | ||
| } | ||
| } |
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 @@ | ||
| resource "sumologic_cloud_to_cloud_source" "vectra-source" { | ||
| collector_id = sumologic_collector.collector.id | ||
| schema_ref = { | ||
| type = "Vectra" | ||
| } | ||
| config = jsonencode({ | ||
| "name": "Vectra", | ||
| "accountURL": "https://123456789012.cc1.portal.vectra.ai", | ||
| "clientId": "8e09xxxxxxxxxxxx36x2d2", | ||
| "clientSecret": "q3Wxxxxxxxxxxxxxxpy4W5MhxJ4xxsRD63hdf", | ||
| "pollingIntervalMin": "5m" | ||
| }) | ||
| } | ||
| resource "sumologic_collector" "collector" { | ||
| name = "my-collector" | ||
| description = "Just testing this" | ||
| } |
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.