From 9fd6a413a4660828c27fcfbdeaaaf3c7a07f65be Mon Sep 17 00:00:00 2001
From: Jagadisha V <129049263+JV0812@users.noreply.github.com>
Date: Thu, 14 Dec 2023 20:20:01 +0530
Subject: [PATCH 1/8] cloudquery-source doc added
---
.../cloudquery-source.md | 98 ++++++++++++++++++
.../index.md | 6 ++
sidebars.ts | 1 +
static/files/c2c/cloudquery/example.json | 23 ++++
static/files/c2c/cloudquery/example.tf | 24 +++++
static/img/send-data/cloudquery-logo.png | Bin 0 -> 12656 bytes
6 files changed, 152 insertions(+)
create mode 100644 docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloudquery-source.md
create mode 100644 static/files/c2c/cloudquery/example.json
create mode 100644 static/files/c2c/cloudquery/example.tf
create mode 100644 static/img/send-data/cloudquery-logo.png
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..13d43e406c
--- /dev/null
+++ b/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cloudquery-source.md
@@ -0,0 +1,98 @@
+---
+id: cloudquery-source
+title: CloudQuery Source
+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';
+
+
+
+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://developer.code42.com/api) |
+
+## Setup
+
+### 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.
+ *  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. **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. **Sevices**. 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 [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
+
+
Provides a secure endpoint to receive System Log data from the Citrix Cloud System Log API.
+Learn how to collect inventory from the AWS APIs.
+Sources in the Cloud-to-Cloud Integration Framework need updates over time to maintain data collection.
Learn how to collect inventory from the CloudQuery AWS APIs.
+Sources in the Cloud-to-Cloud Integration Framework need updates over time to maintain data collection.
Learn how to collect inventory from the CloudQuery AWS APIs.
-