diff --git a/public/docs-static/img/how-to-guides/event-streaming-integration.png b/public/docs-static/img/how-to-guides/event-streaming-integration.png index 5d021ada..3cdf1b45 100644 Binary files a/public/docs-static/img/how-to-guides/event-streaming-integration.png and b/public/docs-static/img/how-to-guides/event-streaming-integration.png differ diff --git a/public/docs-static/img/how-to-guides/firehose-iam-credentials.png b/public/docs-static/img/how-to-guides/firehose-iam-credentials.png new file mode 100644 index 00000000..4023223c Binary files /dev/null and b/public/docs-static/img/how-to-guides/firehose-iam-credentials.png differ diff --git a/public/docs-static/img/how-to-guides/firehose-region-select.png b/public/docs-static/img/how-to-guides/firehose-region-select.png new file mode 100644 index 00000000..6f68366c Binary files /dev/null and b/public/docs-static/img/how-to-guides/firehose-region-select.png differ diff --git a/public/docs-static/img/how-to-guides/firehose-stream-name.png b/public/docs-static/img/how-to-guides/firehose-stream-name.png new file mode 100644 index 00000000..e30ec28c Binary files /dev/null and b/public/docs-static/img/how-to-guides/firehose-stream-name.png differ diff --git a/public/docs-static/img/how-to-guides/s3-bucket-name.png b/public/docs-static/img/how-to-guides/s3-bucket-name.png new file mode 100644 index 00000000..886db4ba Binary files /dev/null and b/public/docs-static/img/how-to-guides/s3-bucket-name.png differ diff --git a/public/docs-static/img/how-to-guides/s3-iam-credentials.png b/public/docs-static/img/how-to-guides/s3-iam-credentials.png new file mode 100644 index 00000000..e16a47c4 Binary files /dev/null and b/public/docs-static/img/how-to-guides/s3-iam-credentials.png differ diff --git a/public/docs-static/img/how-to-guides/s3-region-select.png b/public/docs-static/img/how-to-guides/s3-region-select.png new file mode 100644 index 00000000..b0532686 Binary files /dev/null and b/public/docs-static/img/how-to-guides/s3-region-select.png differ diff --git a/src/pages/how-to/activity-event-streaming.mdx b/src/pages/how-to/activity-event-streaming.mdx index a6aa8062..01a242ef 100644 --- a/src/pages/how-to/activity-event-streaming.mdx +++ b/src/pages/how-to/activity-event-streaming.mdx @@ -8,7 +8,7 @@ This document provides step-by-step instructions and best practices for setting ## Datadog -Before you start creating and configuring a Datadog event-streaming integration, ensure that you have the following: +Before you start creating and configuring a Datadog event streaming integration, ensure that you have the following: - A Datadog account with the permissions to create and manage API keys. If you don't have the required permissions, ask your Datadog administrator to grant them to you. ### Step 1: Create a Datdog API key @@ -17,7 +17,7 @@ Before you start creating and configuring a Datadog event-streaming integration, - Give it a descriptive name like `NetBird Event Streaming` - Click `Create Key` - Copy the key. You will need this key when configuring an integration in NetBird. -### Step 2: Create an event-streaming integration in NetBird +### Step 2: Create an event streaming integration in NetBird - Navigate to the [Integrations » Event Streaming](https://preview.netbird.io/integrations) tab in the NetBird dashboard

event-streaming-integration @@ -31,4 +31,124 @@ Before you start creating and configuring a Datadog event-streaming integration, - Then enter the API key you created in [Step 1](#step-1-create-a-datdog-api-key) and click `Connect`

datadog-api-key +

+ +## Amazon S3 +Before you start creating and configuring an Amazon S3 event streaming integration, ensure that you have the following: +- An AWS account with the permissions to create and manage S3 buckets. +- Permissions to create and manage IAM users, roles and policies. + +If you don't have the required permissions, ask your AWS administrator to grant them to you. + +### Step 1: Create an S3 bucket +- Navigate to the [S3 dashboard](https://console.aws.amazon.com/s3/home) +- Select the correct region in the top menu +- Click `Create bucket` +- Give it a descriptive name like `netbird-activity-events` +- (Optional) Change bucket configurations to your needs +- Click `Create bucket` + +### Step 2: Create an IAM user +- Navigate to the [IAM Dashboard](https://console.aws.amazon.com/iam/home) +- Create an IAM User (for details see the [Amazon Docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html)) +- Create a custom policy with the following permissions: +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "s3:PutObject", + "s3:PutObjectAcl" + ], + "Resource": "arn:aws:s3:::netbird-activity-events/*" + } + ] +} +``` +- Attach the policy to the IAM user +- Select the user and navigate to the `Security credentials` tab +- Click `Create access key` +- Select `Third-party service` and click `Next` +- Give it a description +- Store `Access key` and `Secret access key` in a secure place. You will need these when configuring an integration in NetBird. + +### Step 3: Create an event streaming integration in NetBird +- Navigate to the [Integrations » Event Streaming](https://preview.netbird.io/integrations) tab in the NetBird dashboard +

+ event-streaming-integration +

+ +- Enable and configure the `Amazon S3` integration +- First select the region your S3 bucket is created in +

+ s3-region-select +

+- Then enter the S3 bucket name you created in [Step 1](#step-1-create-an-s3-bucket) and click `Next` +

+ s3-bucket-name +

+- Enter the `Access key` and `Secret access key` you created in [Step 2](#step-2-create-an-iam-user) and click `Connect` +

+ s3-iam-credentials +

+ +## Amazon Data Firehose +Before you start creating and configuring an Amazon Data Firehose event streaming integration, ensure that you have the following: +- An AWS account with the permissions to create and manage data firehose delivery streams. +- Permissions to create and manage IAM users, roles and policies. + +If you don't have the required permissions, ask your AWS administrator to grant them to you. + +### Step 1: Create a Data Firehose stream +- Navigate to the [Data Firehose Dashboard](https://console.aws.amazon.com/firehose/home) +- Click `Create Firehose stream` +- As source select `Direct PUT` and the desired destination +- Give it a descriptive name like `netbird-activity-events` and configure the stream to your needs + +### Step 2: Create an IAM user +- Navigate to the [IAM Dashboard](https://console.aws.amazon.com/iam/home) +- Create an IAM User (for details see the [Amazon Docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html)) +- Create a custom policy with the following permissions (replace the resource with the ARN of your delivery stream): +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "firehose:PutRecord", + "firehose:PutRecordBatch" + ], + "Resource": "arn:aws:firehose:region:accountID:deliverystream/netbird-event-streaming" + } + ] +} +``` +- Attach the policy to the IAM user +- Select the user and navigate to the `Security credentials` tab +- Click `Create access key` +- Select `Third-party service` and click `Next` +- Give it a description +- Store `Access key` and `Secret access key` in a secure place. You will need these when configuring an integration in NetBird. + +### Step 3: Create an event streaming integration in NetBird +- Navigate to the [Integrations » Event Streaming](https://preview.netbird.io/integrations) tab in the NetBird dashboard +

+ event-streaming-integration +

+ +- Enable and configure the `Amazon Data Firehose` integration +- First select the region your Firehose stream is created in +

+ firehose-region-select +

+- Then enter the Firehose stream name you created in [Step 1](#step-1-create-a-data-firehose-stream) and click `Next` +

+ firehose-stream-name +

+- Enter the `Access key` and `Secret access key` you created in [Step 2](#step-2-create-an-iam-user-2) and click `Connect` +

+ firehose-iam-credentials

\ No newline at end of file