# chainguard-dev/terraform-infra-common architecture

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

- Interactive diagram: https://gitdiagram.com/chainguard-dev/terraform-infra-common
- Repository: https://github.com/chainguard-dev/terraform-infra-common

## Overview

##### Project type and purpose
- This repository is a “terraform-infra-common” library: a curated collection of reusable Terraform modules that encapsulate common Google Cloud Run and event-driven patterns, plus accompanying Go-based helper programs (under cmd/ and modules/*/cmd/) and shared libraries (pkg/).
- Its main goal is to provide building blocks for infra-as-code: Cloud Run services (trampolines, brokers, recorders), Pub/Sub triggers, BigQuery sinks, Cloud SQL, dashboards, GitHub bots, networking, etc.

##### File structure
- Top level
- cmd/replayer – a Go CLI
- pkg/ – shared Go libraries (http metrics, pubsub, workqueue, profilers, etc.)
- modules/ – ~30 self-contained Terraform modules. Some modules include Go code under modules/*/cmd/ which is built into container images and deployed by the Terraform module.
- .github/workflows – CI pipelines for Go tests, Terraform validation, docs generation.
- hack/update-docs.sh, README.md, go.mod – build and documentation orchestration.

##### README
- Confirms: “A repository containing a collection of common infrastructure modules for encapsulating common Cloud Run patterns.”
- Usage: top-level Terraform provides a google provider, then consumers import these modules from Terraform Registry.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Build & Publish Tier"
        Developer["Developer"]:::external
        GHAction["GitHub Actions (CI/CD)"]:::cicd
        GoTests["Go Tests (pkg/, modules/*/cmd/)"]:::go
        TerraformLint["Terraform fmt/lint/validate (modules/)"]:::terraform
        UpdateDocs["Update Docs Script"]:::script
        BuildPush["Build & Push Docker Images"]:::container
        PublishModules["Publish Modules to Terraform Registry"]:::registry
    end
    Developer -->|"push code"| GHAction
    GHAction --> GoTests
    GHAction --> TerraformLint
    GHAction --> UpdateDocs
    GHAction --> BuildPush
    GHAction --> PublishModules

    subgraph "Deployment Tier"
        CTCLI["Consumer Terraform CLI"]:::terraform
        TFRegistry["Terraform Registry"]:::registry
        CTCLI --> TFRegistry
        TFRegistry -->|"fetch modules"| CTCLI

        subgraph "GCP Infrastructure"
            subgraph "Eventing Modules"
                BucketModule["Bucket-Events Trampoline Module"]:::terraform
                BrokerModule["CloudEvent Broker Module"]:::terraform
                RecorderModule["CloudEvent Recorder Module"]:::terraform
                PullTriggerModule["CloudEvent Pull-Trigger Module"]:::terraform
                TriggerModule["CloudEvent Trigger Module"]:::terraform
            end
            subgraph "Data Modules"
                BigQuery[("BigQuery Dataset/Table")]:::gcp
                CloudSQL[(Cloud SQL Postgres)]:::gcp
            end
            subgraph "Compute Modules"
                GKECluster[(GKE Cluster & LB)]:::gcp
                RegionalGoService["Regional Go Service Module"]:::terraform
                RegionalService["Regional Service Module"]:::terraform
            end
            subgraph "Monitoring & Networking"
                DashboardModule["Dashboard Module"]:::terraform
                AlertingModule["Alerting Module"]:::terraform
                NetworkingModule["Networking Module"]:::terraform
            end
        end
        CTCLI -->|"provision infra"| GCPInfrastructure
    end

    StorageBucket[("GCS Bucket")]:::gcp
    StorageBucket -->|"object finalized"| BucketModule
    BucketModule -->|"build binary & Docker image"| BuildPush
    BuildPush -->|"deploy image"| BucketService[(Cloud Run: bucket-events-trampoline)]:::container
    BucketService -->|"publish event"| PubSubTopic[("Pub/Sub Topic")]:::gcp
    PubSubTopic -->|"trigger"| BrokerService[(Cloud Run: cloudevent-broker)]:::container
    BrokerService -->|"emit CloudEvent"| BrokerTrigger[("CloudEvents Broker")]:::gcp
    BrokerTrigger --> PullTriggerService[(Cloud Run: pull-trigger)]:::container
    PullTriggerService --> RecorderService[(Cloud Run: recorder)]:::container
    RecorderService -->|"write to"| BigQuery

    classDef external fill:#cccccc,stroke:#333;
    classDef cicd fill:#b3cde0,stroke:#333;
    classDef go fill:#fbb4ae,stroke:#333;
    classDef terraform fill:#ccebc5,stroke:#333;
    classDef container fill:#fed9a6,stroke:#333;
    classDef registry fill:#decbe4,stroke:#333;
    classDef gcp fill:#ffffcc,stroke:#333;

    click GHAction "https://github.com/chainguard-dev/terraform-infra-common/tree/main/.github/workflows/"
    click UpdateDocs "https://github.com/chainguard-dev/terraform-infra-common/blob/main/hack/update-docs.sh"
    click GoTests "https://github.com/chainguard-dev/terraform-infra-common/blob/main/go.mod"
    click Replayer "https://github.com/chainguard-dev/terraform-infra-common/blob/main/cmd/replayer/main.go"
    click pkg "https://github.com/chainguard-dev/terraform-infra-common/tree/main/pkg/"
    click modules "https://github.com/chainguard-dev/terraform-infra-common/tree/main/modules/"
    click BucketModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/bucket-events/*.tf"
    click BucketModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/bucket-events/cmd/trampoline/main.go"
    click BrokerModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudevent-broker/*.tf"
    click BrokerModuleCmd "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudevent-broker/cmd/ingress/main.go"
    click RecorderModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudevent-recorder/*.tf"
    click RecorderCmd1 "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudevent-recorder/cmd/recorder/main.go"
    click RecorderCmd2 "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudevent-recorder/cmd/logrotate/main.go"
    click RecorderCmd3 "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudevent-recorder/cmd/dejavu-bq/main.go"
    click PullTriggerModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudevent-pull-trigger/*.tf"
    click TriggerModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudevent-trigger/*.tf"
    click CloudSQL "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cloudsql-postgres/*.tf"
    click AlertingModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/alerting/*.tf"
    click DashboardModule "https://github.com/chainguard-dev/terraform-infra-common/tree/main/modules/dashboard/"
    click GitHubBots "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/github-bots/*.tf"
    click GitHubBotsSDK "https://github.com/chainguard-dev/terraform-infra-common/tree/main/modules/github-bots/sdk/"
    click GitHubEvents "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/github-events/*.tf"
    click Schemagen "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/github-events/cmd/schemagen/main.go"
    click GHTramp "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/github-events/cmd/trampoline/main.go"
    click GitHubEventsInternal "https://github.com/chainguard-dev/terraform-infra-common/tree/main/modules/github-events/internal/"
    click WorkqueueModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/workqueue/*.tf"
    click WorkqueueCmd "https://github.com/chainguard-dev/terraform-infra-common/tree/main/modules/workqueue/cmd/"
    click NetworkingModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/networking/*.tf"
    click RedisModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/redis/*.tf"
    click GKE "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/gke/*.tf"
    click GKEAP "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/gke-ap/*.tf"
    click ServerlessGCLB "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/serverless-gclb/*.tf"
    click RegionalGoService "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/regional-go-service/*.tf"
    click RegionalService "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/regional-service/*.tf"
    click SecretModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/secret/*.tf"
    click ConfigMapModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/configmap/*.tf"
    click CronModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/cron/*.tf"
    click CronExample "https://github.com/chainguard-dev/terraform-infra-common/tree/main/modules/cron/example/"
    click ProberModule "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/prober/*.tf"
    click GitWIF "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/github-wif-provider/*.tf"
    click GSA "https://github.com/chainguard-dev/terraform-infra-common/blob/main/modules/github-gsa/*.tf"
```
