Skip to content

Commit d6dc1a8

Browse files
authored
Update permission documentation (#3)
* document the rbac requirements for the API key * document the IAM requirements for the KMS policy
1 parent d373329 commit d6dc1a8

1 file changed

Lines changed: 30 additions & 1 deletion

File tree

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Supports both workspace-level and organization-level (Enterprise) audit logs.
1515
## Prerequisites
1616

1717
- Render workspace on Organization or Enterprise plan
18-
- [Render API Key](https://dashboard.render.com/u/settings) (create from Account Settings)
18+
- [Render API Key](https://dashboard.render.com/u/settings) (create from Account Settings). The Render API key must be a User account which is:
19+
- An Admin in every Workspace that will be tracked
20+
- An Owner of the Oranization (Enterprise Plan)
1921
- Render Owner ID (`tea-xxx`) — workspace where the Cron Job will be deployed
2022
- [Terraform](https://www.terraform.io/downloads) >= 1.0
2123
- AWS account with permissions to create S3 buckets and IAM users
@@ -83,6 +85,33 @@ terraform apply \
8385
| `render_cronjob_region` | No | `oregon` | Region to deploy the Cron Job |
8486
| `render_project_name` | No | `audit-logs` | Name of the Render project |
8587

88+
*Note*: If you use a KMS key, confirm that the AWS IAM User is setup with the User Permissions for the key.
89+
90+
Example:
91+
```
92+
{
93+
"Version": "2012-10-17",
94+
"Id": "default",
95+
"Statement": [
96+
{
97+
"Sid": "Allow use of the key",
98+
"Effect": "Allow",
99+
"Principal": {
100+
"AWS": "arn:aws:iam::12345:user/render-audit-log-processor"
101+
},
102+
"Action": [
103+
"kms:Encrypt",
104+
"kms:Decrypt",
105+
"kms:ReEncrypt*",
106+
"kms:GenerateDataKey*",
107+
"kms:DescribeKey"
108+
],
109+
"Resource": "*"
110+
}
111+
]
112+
}
113+
```
114+
86115
## Architecture
87116

88117
The Terraform configuration creates:

0 commit comments

Comments
 (0)