Skip to content

docs(deployments): add Burr UI on AWS deployment example (#391)#829

Open
vaquarkhan wants to merge 2 commits into
apache:mainfrom
vaquarkhan:issue-391-deploy-burr-ui-s3
Open

docs(deployments): add Burr UI on AWS deployment example (#391)#829
vaquarkhan wants to merge 2 commits into
apache:mainfrom
vaquarkhan:issue-391-deploy-burr-ui-s3

Conversation

@vaquarkhan

Copy link
Copy Markdown
Contributor

Adds a deployment example for running the Burr tracking UI server on AWS in a private VPC, reading from an existing S3 tracking bucket. Directly addresses Issue #391 requirements: inside a VPC, parameterizable on S3 bucket, single-tenant server, Terraform.

Architecture: Private VPC with NAT Gateway, SSM VPC Endpoints, EC2 running burr as systemd service, read-only IAM to single bucket, access via SSM port forwarding.

Security: No public IP, no inbound ports, IMDSv2, encrypted EBS, least-privilege IAM, no SSH keys.

Testing: terraform fmt/validate pass, 45 pytest tests pass (structure, license, security, bucket parameterization).

Files: 21 created in examples/deployment/aws/burr-ui/, 1 test, 1 RST doc, 1 toctree update.

Addresses #391

Deploy the Burr tracking UI server in a private VPC on AWS:
- Single EC2 instance in private subnet (single-tenant, per issue requirements)
- SSM Session Manager for private access (no public IP, no open ports)
- Parameterizable on S3 bucket (bring-your-own-bucket)
- Read-only IAM scoped to the single bucket ARN
- VPC with NAT gateway + SSM VPC endpoints
- IMDSv2 enforced, encrypted gp3 EBS
- Systemd service for automatic restart
- 45 automated tests (structure, license, security, terraform fmt/validate)
- Full README with architecture diagram, SSM access, troubleshooting
- RST docs page wired into deployment toctree

Addresses apache#391
@github-actions github-actions Bot added area/website burr.apache.org website area/examples Relates to /examples labels Jun 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/examples Relates to /examples area/website burr.apache.org website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant