Skip to content

Update permission documentation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SEANDOUGHTY wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update permission documentation #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d716b6
document the rbac requirements for the API key
SEANDOUGHTY Jan 13, 2026
c5bee60
document the IAM requirements for the KMS policy
SEANDOUGHTY Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ Supports both workspace-level and organization-level (Enterprise) audit logs.
## Prerequisites

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

*Note*: If you use a KMS key, confirm that the AWS IAM User is setup with the User Permissions for the key.

Example:
```
{
"Version": "2012-10-17",
"Id": "default",
"Statement": [
{
"Sid": "Allow use of the key",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::12345:user/render-audit-log-processor"
},
"Action": [
"kms:Encrypt",
"kms:Decrypt",
"kms:ReEncrypt*",
"kms:GenerateDataKey*",
"kms:DescribeKey"
],
"Resource": "*"
}
]
}
```

## Architecture

The Terraform configuration creates:
Expand Down