Skip to content

docs: add a Terraform deployment example #7

Description

@jeffatgametime

Problem

Open Trove documents S3 configuration and container deployment, but operators do not have a complete infrastructure-as-code example showing the minimum AWS resources and permissions needed for a durable deployment.

Proposed behavior

Add a self-contained example under examples/terraform/aws that:

  • provisions a private S3 artifact bucket with encryption, versioning, and public-access blocking
  • defines least-privilege read/write permissions for the Open Trove workload
  • runs the published image by immutable digest with TROVE_CONFIG_YAML
  • exposes outputs and a teardown path
  • clearly separates portable application configuration from environment-specific networking, DNS, and authentication policy

Validate formatting and configuration in CI without requiring live AWS credentials.

Alternatives considered

A bucket-only snippet is smaller but does not demonstrate how storage credentials, configuration, and the released container fit together.

Compatibility impact

Documentation/example only. It must consume the public image and configuration contract without introducing AWS-specific behavior into the application.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions