# paduartesre/gcp-iam-permissions architecture

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

- Interactive diagram: https://gitdiagram.com/paduartesre/gcp-iam-permissions
- Repository: https://github.com/paduartesre/gcp-iam-permissions

## Overview

##### Project type and purpose
- This is an “Infrastructure as Code” (IaC) Terraform solution for Google Cloud Platform.
- Its primary purpose is to manage IAM bindings for user groups on resources like GCS buckets, audit logs, and GCE instances.
- State is stored in a remote Google Cloud Storage (GCS) bucket backend.

##### File structure
- Top‐level files:
- main.tf – root module invoking submodules (primarily the `iam` module).
- variables.tf – definitions of inputs for root module.
- outputs.tf – outputs exported by the root module.
- terraform.tfvars – concrete variable values (not shown, but implied).
- main Terraform backend config (likely in main.tf).
- `modules/` directory – each subdirectory is a reusable Terraform module for a specific GCP service:
- `modules/iam/` – defines IAM role bindings (variables.tf, main.tf, outputs.tf).
- `modules/appengine/`, `bigquery/`, `cloudbuild/`, `cloudsql/`, etc. – each with its own .tf and variables files ready for future or parallel use.
- The README makes clear the root module currently uses only the `iam` module to apply different bindings.

##### README for additional insights
- The README describes three IAM‐binding scenarios implemented by the root module:
1. Read‐only on GCS buckets for a group.
2. Read‐only on audit logs for a group.
3. Full GCE instance management for a group.
- It specifies a remote state backend on GCS with locking for safe concurrent edits.
- Emphasizes Principle of Least Privilege and secure access to the state bucket.

##### Detail
- Notes on locking, secure backend access, and PoLP.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Terraform Entities
    subgraph "Terraform Entities"
        direction TB
        CLI["Terraform CLI"]:::terraform
        subgraph "Root Module"
            direction TB
            RM_main["main.tf"]:::terraform
            RM_vars["variables.tf"]:::terraform
            RM_outs["outputs.tf"]:::terraform
        end
        subgraph "IAM Submodule"
            direction TB
            IAM_main["modules/iam/main.tf"]:::terraform
            IAM_vars["modules/iam/variables.tf"]:::terraform
            IAM_outs["modules/iam/outputs.tf"]:::terraform
        end
    end

    %% Other Modules (Defined but not currently invoked)
    subgraph "Other Service Modules"
        direction TB
        S_mod["modules/storage/storage.tf"]:::terraform
        S_vars["modules/storage/variables.tf"]:::terraform
        L_mod["modules/logging/logging.tf"]:::terraform
        L_vars["modules/logging/variables.tf"]:::terraform
        G_mod["modules/gce/gce.tf"]:::terraform
        G_vars["modules/gce/variables.tf"]:::terraform
    end

    %% Remote State Backend
    backend["GCS Bucket\n(Terraform State)"]:::state

    %% GCP Services
    subgraph "GCP Services"
        direction TB
        API["GCP IAM API"]:::gcp
        Buckets["GCS Buckets"]:::gcp
        Logs["Audit Logs"]:::gcp
        GCE["GCE Instances"]:::gcp
    end

    %% External Identities
    group["User Groups"]:::external

    %% Connections
    CLI -->|"terraform plan/apply"| RM_main
    CLI -->|"Get/Set state"| backend
    RM_main -->|"invoke iam module\n(Scenario 1-3)"| IAM_main
    RM_main -.->|"defined modules"| S_mod
    RM_main -.-> S_vars
    RM_main -.-> L_mod
    RM_main -.-> L_vars
    RM_main -.-> G_mod
    RM_main -.-> G_vars
    IAM_main -->|"Set IAM binding"| API
    API -->|"roles/storage.objectViewer"| Buckets
    API -->|"roles/logging.viewer"| Logs
    API -->|"roles/compute.admin"| GCE
    group -->|"group identifiers"| IAM_vars

    %% Click Events
    click RM_main "https://github.com/paduartesre/gcp-iam-permissions/blob/main/main.tf"
    click RM_vars "https://github.com/paduartesre/gcp-iam-permissions/blob/main/variables.tf"
    click RM_outs "https://github.com/paduartesre/gcp-iam-permissions/blob/main/outputs.tf"
    click IAM_main "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/iam/main.tf"
    click IAM_vars "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/iam/variables.tf"
    click IAM_outs "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/iam/outputs.tf"
    click S_mod "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/storage/storage.tf"
    click S_vars "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/storage/variables.tf"
    click L_mod "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/logging/logging.tf"
    click L_vars "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/logging/variables.tf"
    click G_mod "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/gce/gce.tf"
    click G_vars "https://github.com/paduartesre/gcp-iam-permissions/blob/main/modules/gce/variables.tf"

    %% Styles
    classDef terraform fill:#D6EAF8,stroke:#1B4F72,color:#154360
    classDef gcp fill:#D5F5E3,stroke:#145A32,color:#0B5345
    classDef state fill:#F2F3F4,stroke:#566573,color:#424949
    classDef external fill:#FDEBD0,stroke:#B9770E,color:#7E5109
```
