Skip to content

Commit 0082ea2

Browse files
committed
Update doc structure and add compatibility section
1 parent d46ff3a commit 0082ea2

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

packages/cisco_umbrella/_dev/build/docs/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
11
# Cisco Umbrella Integration
22

3-
This integration is for [Cisco Umbrella](https://docs.umbrella.com/). It includes the following
4-
datasets for receiving logs from an AWS S3 bucket using an SQS notification queue and Cisco Managed S3 bucket without SQS:
3+
## Overview
4+
5+
This integration is for [Cisco Umbrella](https://docs.umbrella.com/). It includes the following datasets for receiving logs from an AWS S3 bucket using an SQS notification queue and Cisco Managed S3 bucket without SQS:
56

67
- `log` dataset: supports Cisco Umbrella logs.
78

8-
## Setup
9+
### Compatibility
10+
11+
This integration supports the log schema version 8 and 9.
912

10-
### Collect data from Cisco Umbrella
13+
## What do I need to use this integration?
1114

12-
To start collecting logs from Cisco Umbrella, you will need to configure an S3 bucket where the logs will be exported. Depending on your setup, you can choose between a Cisco-managed or a self-managed S3 bucket. Follow the appropriate guide below to complete the setup:
15+
To start collecting logs from Cisco Umbrella, you need to configure an S3 bucket where the logs will be exported. Depending on your setup, you can choose between a Cisco-managed or a self-managed S3 bucket.
1316

1417
- For a Cisco-managed S3 bucket, follow these [step-by-step instructions](https://docs.umbrella.com/deployment-umbrella/docs/cisco-managed-s3-bucket).
1518

1619
- For a self-managed S3 bucket, follow these [step-by-step instructions](https://docs.umbrella.com/deployment-umbrella/docs/setting-up-an-amazon-s3-bucket).
1720

18-
**Note:** Make sure to disable the `Include Optional Log Headers in S3 Export` toggle to prevent optional headers from appearing in the S3 log management report. See [reference](https://docs.umbrella.com/deployment-umbrella/docs/log-formats-and-versioning#view-your-headers).
21+
**Note:** Make sure to disable the `Include Optional Log Headers in S3 Export` toggle to prevent optional headers from appearing in the S3 log management report. Check also the [reference](https://docs.umbrella.com/deployment-umbrella/docs/log-formats-and-versioning#view-your-headers) documentation.
1922

2023
## Logs
2124

2225
### Umbrella
2326

24-
When using Cisco Managed S3 buckets that does not use SQS there is no load balancing possibilities for multiple agents, a single agent should be configured to poll the S3 bucket for new and updated files, and the number of workers can be configured to scale vertically.
27+
When using Cisco Managed S3 buckets that do not use SQS, there is no load balancing for multiple agents. A single agent should be configured to poll the S3 bucket for new and updated files, and the number of workers can be configured to scale vertically.
2528

2629
The `log` dataset collects Cisco Umbrella logs.
2730

packages/cisco_umbrella/docs/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
11
# Cisco Umbrella Integration
22

3-
This integration is for [Cisco Umbrella](https://docs.umbrella.com/). It includes the following
4-
datasets for receiving logs from an AWS S3 bucket using an SQS notification queue and Cisco Managed S3 bucket without SQS:
3+
## Overview
4+
5+
This integration is for [Cisco Umbrella](https://docs.umbrella.com/). It includes the following datasets for receiving logs from an AWS S3 bucket using an SQS notification queue and Cisco Managed S3 bucket without SQS:
56

67
- `log` dataset: supports Cisco Umbrella logs.
78

8-
## Setup
9+
### Compatibility
10+
11+
This integration supports the log schema version 8 and 9.
912

10-
### Collect data from Cisco Umbrella
13+
## What do I need to use this integration?
1114

12-
To start collecting logs from Cisco Umbrella, you will need to configure an S3 bucket where the logs will be exported. Depending on your setup, you can choose between a Cisco-managed or a self-managed S3 bucket. Follow the appropriate guide below to complete the setup:
15+
To start collecting logs from Cisco Umbrella, you need to configure an S3 bucket where the logs will be exported. Depending on your setup, you can choose between a Cisco-managed or a self-managed S3 bucket.
1316

1417
- For a Cisco-managed S3 bucket, follow these [step-by-step instructions](https://docs.umbrella.com/deployment-umbrella/docs/cisco-managed-s3-bucket).
1518

1619
- For a self-managed S3 bucket, follow these [step-by-step instructions](https://docs.umbrella.com/deployment-umbrella/docs/setting-up-an-amazon-s3-bucket).
1720

18-
**Note:** Make sure to disable the `Include Optional Log Headers in S3 Export` toggle to prevent optional headers from appearing in the S3 log management report. See [reference](https://docs.umbrella.com/deployment-umbrella/docs/log-formats-and-versioning#view-your-headers).
21+
**Note:** Make sure to disable the `Include Optional Log Headers in S3 Export` toggle to prevent optional headers from appearing in the S3 log management report. Check also the [reference](https://docs.umbrella.com/deployment-umbrella/docs/log-formats-and-versioning#view-your-headers) documentation.
1922

2023
## Logs
2124

2225
### Umbrella
2326

24-
When using Cisco Managed S3 buckets that does not use SQS there is no load balancing possibilities for multiple agents, a single agent should be configured to poll the S3 bucket for new and updated files, and the number of workers can be configured to scale vertically.
27+
When using Cisco Managed S3 buckets that do not use SQS, there is no load balancing for multiple agents. A single agent should be configured to poll the S3 bucket for new and updated files, and the number of workers can be configured to scale vertically.
2528

2629
The `log` dataset collects Cisco Umbrella logs.
2730

0 commit comments

Comments
 (0)