-
Notifications
You must be signed in to change notification settings - Fork 228
Sysdig Secure Source (c2c Collector) #5037
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
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
3b869bf
Sysdig Secure (c2c Collector)
amee-sumo 1482894
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 1ed7ca5
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 0222a99
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo a97b9a8
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 9ec3664
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 7020deb
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo fd9b4d9
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo fa548e9
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 09f6665
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo a645278
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 90431e3
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo f856115
Update blog-service/2025-02-17-collection.md
amee-sumo f080f7f
Update sysdig-secure-source.md
amee-sumo 82bbd6d
added API links
amee-sumo 43f1cfd
Update blog-service/2025-02-17-collection.md
amee-sumo edae188
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 905252e
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo c9ae370
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 04d5f88
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo edc7562
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo d6807e9
Merge branch 'main' into Sysdig-Secure-C2C
priyansh-sumo 717c9ea
Rename 2025-02-17-collection.md to 2025-02-18-collection.md
JV0812 0efae49
Update docs/integrations/product-list/product-list-m-z.md
JV0812 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,14 @@ | ||
| --- | ||
| title: Sysdig Secure Source (Collection) | ||
| image: https://help.sumologic.com/img/sumo-square.png | ||
| keywords: | ||
| - apps | ||
| - sysdig-secure-source | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a> | ||
|
|
||
| We're excited to announce the release of our new cloud-to-cloud source for Sysdig Secure. This source aims to collect the scan results from the scanner using Sysdig API and send them to Sumo Logic for streamlined analysis. [Learn more](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/sysdig-secure-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
109 changes: 109 additions & 0 deletions
109
.../hosted-collectors/cloud-to-cloud-integration-framework/sysdig-secure-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,109 @@ | ||
| --- | ||
| id: sysdig-secure-source | ||
| title: Sysdig Secure Source | ||
| sidebar_label: Sysdig Secure | ||
| tags: | ||
| - cloud-to-cloud | ||
| - sysdig-secure | ||
| description: The Sysdig Secure Source aims to collect the scan results from the scanner using Sysdig API and send them to Sumo Logic. | ||
| --- | ||
|
|
||
| import CodeBlock from '@theme/CodeBlock'; | ||
| import ExampleJSON from '/files/c2c/sysdig-secure/example.json'; | ||
| import MyComponentSource from '!!raw-loader!/files/c2c/sysdig-secure/example.json'; | ||
| import TerraformExample from '!!raw-loader!/files/c2c/sysdig-secure/example.tf'; | ||
| import ForwardToSiem from '/docs/reuse/forward-to-siem.md'; | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/integrations/misc/sysdig-logo.png')} alt="icon" width="125"/> | ||
|
|
||
| Sysdig Secure is a comprehensive security platform that provides continuous security and compliance monitoring for cloud-native environments. This is designed specifically to address the security needs of modern containerised and Kubernetes infrastructures. Sysdig Secure enables organisations to detect, prevent, and respond to security threats and ensure compliance in real-time. | ||
|
|
||
| ## Data collected | ||
|
|
||
| | Polling Interval | Data | | ||
| | :--- | :--- | | ||
| | 24 hours | [Runtime Scan Result](https://us2.app.sysdig.com/apidocs/secure/#tag/Vulnerability-Management/operation/ScannerAPIServiceListRuntimeResults) | | ||
| | 5 minutes | [Full Scan Result](https://us2.app.sysdig.com/apidocs/secure/#tag/Vulnerability-Management/operation/GetSecureVulnerabilityV1ResultsResultId) | | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| The Sysdig Secure Source supports API token-based authentication and requires you to provide the Sysdig Secure Base URL and API token to access the data. | ||
|
|
||
| #### Base URL | ||
|
|
||
| The **Base URL** is the Sysdig Secure domain URL that corresponds to the region in which the account is created. For example, `https://api.us2.sysdig.com`. | ||
|
|
||
| #### Bearer token | ||
|
|
||
| The **Bearer Token** is the API security token used to authenticate with Sysdig HTTP API. Follow the steps below to collect your Sysdig API token: | ||
|
|
||
| 1. Sign in to the **Sysdig Secure** platform. | ||
| 1. Select **Settings** from the **User Menu**. | ||
| 1. In the **Settings** page, select **User Profile** to view the Sysdig Secure API token in the UI. | ||
| 1. Copy the token or click the **Reset Token** button to generate a new one. | ||
|
|
||
| :::info | ||
| When a token is reset, the previously issued token will immediately become invalid. | ||
| ::: | ||
|
|
||
| ### Source configuration | ||
|
|
||
| When you create a Sysdig Secure 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 Sysdig Secure Source: | ||
| 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 **Sysdig Secure**. | ||
| 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 is ignored, known as dropped. | ||
| 1. **Base URL**. Enter the [Sysdig Secure platform](#base-url) Base URL. For example, `https://api.us2.sysdig.com`. | ||
| 1. **Bearer Token**. Enter the Sysdig Secure API token collected from the [Sysdig Secure](#bearer-token) platform. For example, `t3fPdsbxxxxxxxxxp4D6hbi4`. | ||
| 1. (Optional) **Filters**. Click the **+Add** button to define the filters you want to associate. Each filter needs a **Field Name** (key) and **Field Value** (value). For key-value pairs, the length is set to 256 characters and the API accepts a maximum length of 1024 characters for the filter. | ||
| 1. (Optional) **Processing Rules for Logs**. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in [Create a Processing Rule](/docs/send-data/collection/processing-rules/create-processing-rule). | ||
amee-sumo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details. | ||
|
|
||
| | Parameter | Type | Value | Required | Description | | ||
| |:--|:--|:--|:--|:--| | ||
| | schemaRef | JSON Object | `{“type”: “Sysdig Secure”}` | 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"}` | | ||
| | baseURL | String | Yes | `null` | The Sysdig base URL of your region. | `https://api.us2.sysdig.com` | | ||
| | apiToken | String | Yes | `null` | The API token of your Sysdig account. | `t3fPdsbxxxxxxxxxp4D6hbi4` | | ||
| | filters | Array | No | `null` | An array of key-value pairs to filter the data. For key-value pairs, the length is set to 256 characters and the API accepts a maximum length of 1024 characters for the filter. | | | ||
|
|
||
| ### JSON example | ||
|
|
||
| <CodeBlock language="json">{MyComponentSource}</CodeBlock> | ||
|
|
||
| <a href="/files/c2c/sysdig-secure/example.json" target="_blank">Download example</a> | ||
|
|
||
| ### Terraform example | ||
|
|
||
| <CodeBlock language="json">{TerraformExample}</CodeBlock> | ||
|
|
||
| <a href="/files/c2c/sysdig-secure/example.tf" target="_blank">Download example</a> | ||
|
|
||
| ## 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,19 @@ | ||
| { | ||
| "api.version": "v1", | ||
| "source": { | ||
| "config": { | ||
| "name": "Sysdig", | ||
| "baseURL": "https://us2.app.sysdig.com", | ||
| "bearerToken": "wdwxxxxxqwedwedxxxxxqewdxxxxxxqwedxxxx", | ||
| "scope": [ | ||
| { | ||
| "fieldName": "Field", | ||
| "fieldValue": "Value" | ||
| } | ||
| ] | ||
| }, | ||
| "schemaRef": { | ||
| "type": "Sysdig" | ||
| }, | ||
| "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,21 @@ | ||
| resource "sumologic_cloud_to_cloud_source" "sysdig-secure-source" { | ||
| collector_id = sumologic_collector.collector.id | ||
| schema_ref = { | ||
| type = "Sysdig" | ||
| } | ||
| config = jsonencode({ | ||
| "name": "Sysdig", | ||
| "baseURL": "https://us2.app.sysdig.com", | ||
| "bearerToken": "wdwxxxxxqwedwedxxxxxqewdxxxxxxqwedxxxx", | ||
| "scope": [ | ||
| { | ||
| "fieldName": "Field", | ||
| "fieldValue": "Value" | ||
| } | ||
| ] | ||
| }) | ||
| } | ||
| 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.