AWS Deployment Example¶

This example covers deploying Burr tracking infrastructure on AWS with S3, and optionally SQS for event-driven updates.

The Terraform module lives in:

  • examples/deployment/aws/terraform

Architecture¶

S3-only (polling mode):

  • Burr applications write tracking data to S3.

  • Tracking server polls/indexes S3 and serves the UI.

S3+SQS (event-driven mode):

  • S3 object notifications are delivered to SQS.

  • Tracking server consumes SQS and ingests updates with lower latency.

Quick Start¶

cd examples/deployment/aws/terraform
terraform init
terraform apply -var-file=dev.tfvars   # S3 polling mode
# or
terraform apply -var-file=prod.tfvars  # S3 + SQS event-driven mode

After apply, inspect outputs:

terraform output burr_environment_variables

Set these environment variables in the runtime where you launch burr.

Terraform Variables and Modes¶

Key variables:

  • aws_region (default us-east-1)

  • environment (for example dev / prod)

  • s3_bucket_name (optional custom name)

  • enable_sqs (true for event-driven mode)

  • sqs_queue_name

  • log_retention_days

  • snapshot_retention_days

  • dlq_alarm_notification_emails

Mode mapping:

  • dev.tfvars: S3-only (polling)

  • prod.tfvars: S3 + SQS (event-driven)

Terraform Outputs¶

Useful outputs include:

  • s3_bucket_name

  • sqs_queue_url

  • sqs_dlq_url

  • dlq_alarm_arn

  • dlq_alarm_sns_topic_arn

  • burr_environment_variables