Skip to content

Commit

Permalink
Update ingestion.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Samrose-Ahmed authored May 4, 2023
1 parent 3562069 commit 6f68278
Showing 1 changed file with 32 additions and 9 deletions.
41 changes: 32 additions & 9 deletions docs/log-sources/ingestion.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,38 @@ ingest:
key_prefix: "my_key/mypath"
```
If you are bringing your own bucket, you need to ensure that you have correctly set up permissions on the bucket for Matano to be able to access it.
#### Bring your own bucket S3 permissions
If you are bringing your own bucket, you need to ensure that you have correctly set up permissions on the bucket for Matano to be able to access it. Here is a sample S3 bucket policy you can use to grant Matano access to your bucket.
```json
{
"Statement": {
"Effect": "Allow",
"Action": [
"s3:GetObject",
"s3:GetBucketNotificationConfiguration",
"s3:PutBucketNotificationConfiguration"
],
"Principal": {
"AWS": "<MATANO-ACCOUNT>"
},
"Condition":{
"StringEquals": {
"aws:PrincipalTag/matano:managed": "true"
}
}
}
}
```

#### Ingesting from a bucket with KMS encryption

To allow Matano to ingest data from a bucket with KMS encryption, in addition to setting the S3 bucket policy, add a tag on your KMS Key as follows:

```
matano:trusted=true
```

#### Using a key pattern to match non consecutive key patterns

Expand All @@ -62,14 +93,6 @@ A wildcard is used to match the account ID as part of the key pattern to the log
To specify minimum IAM identity permissions, Matano will continue to use the `key_prefix` configuration. If no `key_prefix` is provided, permission to read all objects in the source bucket will added to the identity policy.

#### Ingesting from a bucket with KMS encryption

To allow Matano to ingest data from a bucket with KMS encryption, in addition to setting the resource based policy, add a tag on your KMS Key as follows:

```
matano:trusted=true
```

This will allow the Matano system identity based policy to be able to decrypt ingestion data.

## Expanding records
Expand Down

1 comment on commit 6f68278

@vercel
Copy link

@vercel vercel bot commented on 6f68278 May 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.