diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloudquery-source.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloudquery-source.md new file mode 100644 index 0000000000..2238d3720a --- /dev/null +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloudquery-source.md @@ -0,0 +1,108 @@ +--- +id: cloudquery-source +title: CloudQuery Source (Beta) +sidebar_label: CloudQuery +tags: + - cloud-to-cloud + - cloudquery +description: Learn how to collect inventory from the AWS APIs and transform them into the CloudQuery schema and send it to Sumo Logic. +--- + +import CodeBlock from '@theme/CodeBlock'; +import ExampleJSON from '/files/c2c/cloudquery/example.json'; +import MyComponentSource from '!!raw-loader!/files/c2c/cloudquery/example.json'; +import TerraformExample from '!!raw-loader!/files/c2c/cloudquery/example.tf'; +import useBaseUrl from '@docusaurus/useBaseUrl'; + + + + + +

Beta

+ +cloudquery-icon + +The CloudQuery integration is used to pull inventory from the AWS APIs and transform them into the CloudQuery schema and send it to Sumo Logic. + +:::note +This source is available in the [Fed deployment](https://hub.cloudquery.io/plugins/source/cloudquery/aws/v22.19.2/docs). +::: + +## Data collected + +| Polling Interval | Data | +| :--- | :--- | +| 24 hours | [Data service table data](https://hub.cloudquery.io/plugins/source/cloudquery/aws/v22.19.2/docs) | + +## Setup + +### Vendor configuration + +The integration must be configured with the Access Key ID and Secret Access Key. Refer to the [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for guidance to create the Access Key ID and Secret Access Key. + +### Source configuration + +When you create an CloudQuery 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](/docs/send-data/hosted-collectors/configure-hosted-collector). + +To configure a CloudQueryr Source: +1. In Sumo Logic, select **Manage Data** > **Collection** > **Collection**.  +1. On the Collection page, click **Add Source** next to a Hosted Collector. +1. Search for and select **CloudQuery**. +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. + * ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists in the Fields table schema. + * ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) 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. **AWS Access Key ID**. Enter the Access Key ID collected from the [AWS Management Console](#vendor-configuration). +1. **AWS Secret Access Key**. Enter the Secret Access Key collected from the [AWS Management Console](#vendor-configuration). +1. **Regions**. Identify and enter your Region based on your Base URL. +1. **Services**. Enter the type of service from which the data needs to be collected. +1. By default, **Polling Interval** is set to 24 hours. +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":"CloudQuery"}` | 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"}` | +| awsId | String | Yes | `null` | The AWS access ID that you want to use to authenticate collection requests. | | +| awsKey | String | Yes | `null` | The AWS secret key that you want to use to authenticate collection requests. | | +| limitToRegions | Array | Yes | | List of regions for which the data has to be fetched. | | +| limitToServices | Array | Yes | | List of services for which the data has to be fetched. | | +| pollingInterval | Integer | No | 24 | This sets how often the Source checks for data. | | + +### JSON example + +{MyComponentSource} + +[Download example](/files/c2c/cloudquery/example.json) + +### Terraform example + +{TerraformExample} + +[Download example](/files/c2c/cloudquery/example.tf) + +## Limitations + +- The integration lacks support for fetching service table data from multiple AWS accounts. +- The integration does not support to retrieve data from services like Classic load balancer, Network load balancer, Aurora, and VPC. + +## FAQ + +:::info +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. +::: \ No newline at end of file diff --git a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md index 398d234ab8..5cdd3aa90d 100644 --- a/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md +++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/index.md @@ -43,7 +43,7 @@ For the Federal environments, a different set of Static IPs is available for eac ## Integrations -The topics below are the available integrations. In Sumo Logic these are called Sources. Check out the Sources we have available in beta. +The topics below are the available integrations. In Sumo Logic these are called Sources. Check out the Sources we have available in beta. ## Versions diff --git a/sidebars.ts b/sidebars.ts index 144f623cb8..7f58b22704 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -271,6 +271,7 @@ module.exports = { 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/citrix-cloud-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cse-aws-ec-inventory-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloud-to-cloud-source-versions', + //'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloudquery-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/code42-incydr-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-source', 'send-data/hosted-collectors/cloud-to-cloud-integration-framework/crowdstrike-fdr-source', diff --git a/static/files/c2c/cloudquery/example.json b/static/files/c2c/cloudquery/example.json new file mode 100644 index 0000000000..44ac299258 --- /dev/null +++ b/static/files/c2c/cloudquery/example.json @@ -0,0 +1,23 @@ +{ + "api.version": "v1", + "source": { + "config": { + "name": "CloudQuery AWS Inventory", + "accessKeyId": "************", + "secretAccessKey": "***************************", + "limitToRegions": [ + "us-east-1", + "us-east-2" + ], + "awsServices": [ + "ECS", + "EC2" + ], + "pollInterval": 24 + }, + "schemaRef": { + "type": "CloudQuery AWS Inventory" + }, + "sourceType": "Universal" + } +} \ No newline at end of file diff --git a/static/files/c2c/cloudquery/example.tf b/static/files/c2c/cloudquery/example.tf new file mode 100644 index 0000000000..24d13ccc7f --- /dev/null +++ b/static/files/c2c/cloudquery/example.tf @@ -0,0 +1,24 @@ +resource "sumologic_cloud_to_cloud_source" "cloudquery_source" { + collector_id = sumologic_collector.collector.id + schema_ref = { + type = "CloudQuery" + } + config = jsonencode({ + "name": "CloudQuery AWS Inventory", + "accessKeyId": "************", + "secretAccessKey": "***************************", + "limitToRegions": [ + "us-east-1", + "us-east-2" + ], + "awsServices": [ + "ECS", + "EC2" + ], + "pollInterval": 24 + }) +} +resource "sumologic_collector" "collector" { + name = "my-collector" + description = "Just testing this" +} \ No newline at end of file diff --git a/static/img/send-data/cloudquery-logo.png b/static/img/send-data/cloudquery-logo.png new file mode 100644 index 0000000000..f9b1228aa4 Binary files /dev/null and b/static/img/send-data/cloudquery-logo.png differ