# corymhall/example-terraform-project architecture

> Architecture diagram of the GitHub repository corymhall/example-terraform-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/corymhall/example-terraform-project
- Repository: https://github.com/corymhall/example-terraform-project

## Overview

##### Project type and purpose
- This is a Terraform-based “infrastructure as code” mono-repo.
- Purpose: define, organize, and test AWS infrastructure in multiple environments (prod/non-prod) and regions using Terraform workspaces and reusable modules.

##### File structure
- Top-level folders:
- meta – environment‐to‐account mappings
- app-infrastructure – per-application ECS/ALB infrastructure, one Terraform workspace per env+region
- core-infrastructure – shared infra (VPC, ACM, etc.), one workspace per account+region
- modules – reusable Terraform modules (alb, ecs_service, ecs_task, s3-iam)
- modules/tests – Terratest suite for module validation
- Common patterns:
- Layered architecture: modules at bottom → core/app infra at mid → AWS as deployment target
- Workspace isolation: separate state per environment
- CI tests invoking real AWS provisioning via Terratest

##### Key README insights
- Separation of core vs. app infra to limit blast radius
- One workspace per environment OR region/account
- Modules abstract AWS resource details for safety and reusability
- Terratest for end-to-end module testing

##### Main components
1. Terraform Modules
– alb, ecs_service, ecs_task, s3-iam
2. Core Infrastructure Workspaces
– core-infrastructure: prd-useast1, prd-useast2, nonprd-useast1, nonprd-useast2
3. App Infrastructure Workspaces
– app-infrastructure: prd-useast1/2, dev-useast1/2, stg-useast1/2
4. Meta
– environment→AWS account mapping
5. Terratest CI
– invokes modules/tests, provisions sample infra, validates, then tears down
6. AWS Accounts & Regions
– prod account, non-prod account, each in us-east-1 & us-east-2

b. Relationships and data flow
- Modules�←─used by─ Core Infra & App Infra workspaces
- Workspaces�←─import─ Meta mappings
- Workspaces�→─provision─ AWS (accounts/regions)
- Terratest CI�→─runs Terraform on modules, orchestrates AWS provisioning & tests

c. Architectural patterns
- Layered composition (modules → infra layers)
- Workspace isolation for environment management
- Infrastructure modularization for reusability & safety
- CI testing of actual infrastructure

d. Key technologies & frameworks
- Terraform v0.12+ (HCL code, workspaces)
- AWS (ECS, ALB, VPC, IAM, ACM, S3)
- Terratest (Go) for end-to-end infra tests

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Modules Layer
    subgraph "Terraform Modules"
        direction TB
        alb["ALB Module"]:::modules
        ecsService["ECS Service Module"]:::modules
        ecsTask["ECS Task Module"]:::modules
        s3iam["S3-IAM Module"]:::modules
    end

    %% Core Infrastructure Layer
    subgraph "Core Infrastructure Workspaces" 
        direction TB
        core_prd1["core-infrastructure: prd-us-east-1"]:::core
        core_prd2["core-infrastructure: prd-us-east-2"]:::core
        core_nonprd1["core-infrastructure: nonprd-us-east-1"]:::core
        core_nonprd2["core-infrastructure: nonprd-us-east-2"]:::core
    end

    %% App Infrastructure Layer
    subgraph "App Infrastructure Workspaces"
        direction TB
        app_prd1["app-infrastructure: prd-us-east-1"]:::app
        app_prd2["app-infrastructure: prd-us-east-2"]:::app
        app_dev1["app-infrastructure: dev-us-east-1"]:::app
        app_dev2["app-infrastructure: dev-us-east-2"]:::app
        app_stg1["app-infrastructure: stg-us-east-1"]:::app
        app_stg2["app-infrastructure: stg-us-east-2"]:::app
    end

    %% Meta Layer
    Meta["Meta Environment→Account Mapping"]:::meta

    %% CI Layer
    CI["Terratest CI Suite"]:::ci

    %% AWS Layer
    subgraph "AWS Accounts & Regions"
        direction TB
        prod1["Prod Account us-east-1"]:::aws
        prod2["Prod Account us-east-2"]:::aws
        nonprd1["Non-Prod Account us-east-1"]:::aws
        nonprd2["Non-Prod Account us-east-2"]:::aws
    end

    %% Dependencies
    alb -->|used by| core_prd1
    alb -->|used by| core_prd2
    alb -->|used by| core_nonprd1
    alb -->|used by| core_nonprd2
    alb -->|used by| app_prd1
    alb -->|used by| app_prd2
    alb -->|used by| app_dev1
    alb -->|used by| app_dev2
    alb -->|used by| app_stg1
    alb -->|used by| app_stg2

    ecsService -->|used by| core_prd1
    ecsService -->|used by| core_prd2
    ecsService -->|used by| core_nonprd1
    ecsService -->|used by| core_nonprd2
    ecsService -->|used by| app_prd1
    ecsService -->|used by| app_prd2
    ecsService -->|used by| app_dev1
    ecsService -->|used by| app_dev2
    ecsService -->|used by| app_stg1
    ecsService -->|used by| app_stg2

    ecsTask -->|used by| core_prd1
    ecsTask -->|used by| core_prd2
    ecsTask -->|used by| core_nonprd1
    ecsTask -->|used by| core_nonprd2
    ecsTask -->|used by| app_prd1
    ecsTask -->|used by| app_prd2
    ecsTask -->|used by| app_dev1
    ecsTask -->|used by| app_dev2
    ecsTask -->|used by| app_stg1
    ecsTask -->|used by| app_stg2

    s3iam -->|used by| core_prd1
    s3iam -->|used by| core_prd2
    s3iam -->|used by| core_nonprd1
    s3iam -->|used by| core_nonprd2
    s3iam -->|used by| app_prd1
    s3iam -->|used by| app_prd2
    s3iam -->|used by| app_dev1
    s3iam -->|used by| app_dev2
    s3iam -->|used by| app_stg1
    s3iam -->|used by| app_stg2

    Meta -->|imports| core_prd1
    Meta -->|imports| core_prd2
    Meta -->|imports| core_nonprd1
    Meta -->|imports| core_nonprd2
    Meta -->|imports| app_prd1
    Meta -->|imports| app_prd2
    Meta -->|imports| app_dev1
    Meta -->|imports| app_dev2
    Meta -->|imports| app_stg1
    Meta -->|imports| app_stg2

    core_prd1 -->|provisions| prod1
    core_prd2 -->|provisions| prod2
    core_nonprd1 -->|provisions| nonprd1
    core_nonprd2 -->|provisions| nonprd2

    app_prd1 -->|provisions| prod1
    app_prd2 -->|provisions| prod2
    app_dev1 -->|provisions| nonprd1
    app_dev2 -->|provisions| nonprd2
    app_stg1 -->|provisions| nonprd1
    app_stg2 -->|provisions| nonprd2

    CI -->|runs tests on| alb
    CI -->|runs tests on| ecsService
    CI -->|runs tests on| ecsTask
    CI -->|runs tests on| s3iam
    CI -->|orchestrates| prod1
    CI -->|orchestrates| prod2
    CI -->|orchestrates| nonprd1
    CI -->|orchestrates| nonprd2

    %% Click Events
    click alb "https://github.com/corymhall/example-terraform-project/blob/master/modules/alb/main.tf"
    click ecsService "https://github.com/corymhall/example-terraform-project/blob/master/modules/ecs_service/main.tf"
    click ecsTask "https://github.com/corymhall/example-terraform-project/blob/master/modules/ecs_task/main.tf"
    click s3iam "https://github.com/corymhall/example-terraform-project/blob/master/modules/s3-iam/main.tf"
    click core_prd1 "https://github.com/corymhall/example-terraform-project/blob/master/core-infrastructure/backend.tf"
    click app_prd1 "https://github.com/corymhall/example-terraform-project/blob/master/app-infrastructure/backend.tf"
    click Meta "https://github.com/corymhall/example-terraform-project/blob/master/meta/backend.tf"
    click CI "https://github.com/corymhall/example-terraform-project/blob/master/modules/tests/main_test.go"

    %% Styles
    classDef modules fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef core fill:#90EE90,stroke:#000,stroke-width:1px
    classDef app fill:#FFA500,stroke:#000,stroke-width:1px
    classDef meta fill:#D3D3D3,stroke:#000,stroke-width:1px
    classDef ci fill:#DDA0DD,stroke:#000,stroke-width:1px
    classDef aws fill:#87CEEB,stroke:#000,stroke-width:1px
```
