# terraform-ibm-modules/terraform-ibm-cbr architecture

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

- Interactive diagram: https://gitdiagram.com/terraform-ibm-modules/terraform-ibm-cbr
- Repository: https://github.com/terraform-ibm-modules/terraform-ibm-cbr

## Overview

##### Project type and purpose
- This is an Infrastructure-as-Code (IaC) Terraform **module library** for IBM Cloud Context-Based Restrictions.
- It contains reusable submodules (`cbr-rule-module`, `cbr-zone-module`, `cbr-service-profile`, `fscloud`), example configurations, CI/CD workflows, and tests.

##### File structure
Top-level directories/files and their roles:
- `.github/workflows/` – CI/CD definitions for linting, testing, releasing.
- `modules/` – core Terraform submodules:
– `cbr-rule-module`
– `cbr-zone-module`
– `cbr-service-profile`
– `fscloud` (opinionated “secure by default” composite)
- `examples/` – sample Terraform root modules showing how to consume the submodules.
- `tests/` – Go-based integration/PR validation tests.
- `Makefile`, `.pre-commit-config.yaml` – developer tooling.
- `main.tf`, `variables.tf`, `outputs.tf`, `version.tf` – root placeholder Terraform files.

##### README
- Describes module purpose, usage code snippets, required IAM policies, supported Terraform/IBM provider versions.
- Lists submodules and example scenarios.

##### Core components
A. **Code Repository** (GitHub)
- Houses source modules, examples, tests, CI/CD configs.
B. **CI/CD Pipeline** (GitHub Actions)
1. Pre-commit checks → Terraform fmt, lint, docs.
2. CI workflow (`ci.yml`) → runs Terraform validate, tests.
3. Release workflow (`release.yml`) → semantic-release, publishes new module versions.
C. **Terraform Modules**
- **cbr-zone-module** → creates IBM CBR Zone (addresses, refs).
- **cbr-rule-module** → creates IBM CBR Rule (contexts, resources, operations).
- **cbr-service-profile** → optional profile settings for rule enforcement.
- **fscloud** → opinionated wrapper combining zones + rules for “secure-by-default” FS-Cloud use case.
D. **Example Consumers**
- Example root Terraform configs that `module "ibm_cbr"` sources from `./modules/...`.
E. **IBM Cloud Provider API**
- Target runtime: calls to `ibm_cbr_zone_v1`, `ibm_cbr_rule_v1` resources via the IBM Terraform Provider.

##### Relationships & data flow
1. Developer pushes code → GitHub repo.
2. GitHub Actions triggers:
- Pre-commit & CI validate modules & examples.
- On release, semantic-release publishes versions to Terraform Registry.
3. Consumers clone repo or pull published registry module.
4. Terraform `apply` invokes submodules → IBM Cloud Provider → provisions CBR Zones & Rules.

##### Architectural patterns & principles
- **Modularity**: each submodule encapsulates one resource type or opinionated grouping.
- **Composition**: `fscloud` composes multiple submodules for a higher-level pattern.
- **Separation of concerns**: code vs. examples vs. CI vs. docs vs. tests.

Layer 1 (Left):
- GitHub Repository
– Modules folder
– Examples folder
– Tests folder
– CI/CD configs
Layer 2 (Middle – CI/CD):
- Pre-commit checks
- CI Workflow
- Release Workflow → Terraform Registry
Layer 3 (Right – Runtime):
- Example Root Module (user code)
– Sources modules from Registry or local `./modules/`
- Terraform CLI
- IBM Cloud Provider → CBR Zone & Rule APIs

## Diagram (Mermaid)

```mermaid
flowchart TD
  subgraph "Development Phase"
    direction TB
    Repo["GitHub Repository"]:::code
    subgraph "Modules"
      direction TB
      ZoneMod["cbr-zone-module"]:::code
      RuleMod["cbr-rule-module"]:::code
      ServiceMod["cbr-service-profile"]:::code
      FscloudMod["fscloud"]:::code
    end
    subgraph "Examples"
      direction TB
      Ex1["fscloud scenario"]:::code
      Ex2["multi-resource-rule"]:::code
      Ex3["multi-service-profile"]:::code
      Ex4["multizone-rule"]:::code
      Ex5["update-existing-zone-addresses"]:::code
      Ex6["zone only"]:::code
    end
    Tests["Integration & PR Tests"]:::code
    CiConfigs["CI/CD Configs"]:::ci
    RootTF["Root Terraform placeholders"]:::code
  end

  subgraph "CI/CD Pipeline"
    direction TB
    Precommit["Pre-commit Checks"]:::ci
    CI["CI Workflow"]:::ci
    Release["Release Workflow"]:::ci
  end

  subgraph "Runtime Provisioning"
    direction TB
    ERM["Example Root Module"]:::code
    CLI["Terraform CLI"]:::code
    IBM["IBM Cloud Provider APIs"]:::runtime
  end

  Repo -->|"push event"| Precommit
  Repo -->|"push event"| CI
  Repo -->|"push event"| Release
  Precommit -->|"checks complete"| CI
  CI -->|"tests run"| Tests
  Release -->|"semantic-release publish"| ERM

  ERM -->|"uses module"| ZoneMod
  ERM -->|"uses module"| RuleMod
  ERM -->|"uses module"| ServiceMod
  ERM -->|"uses module"| FscloudMod

  ERM -->|"terraform init/apply"| CLI
  CLI -->|"provisions CBR Zones & Rules"| IBM

  click Repo "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main//"
  click Precommit "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/blob/main/.pre-commit-config.yaml"
  click CI "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/blob/main/.github/workflows/ci.yml"
  click Release "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/blob/main/.github/workflows/release.yml"
  click ZoneMod "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/modules/cbr-zone-module/"
  click RuleMod "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/modules/cbr-rule-module/"
  click ServiceMod "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/modules/cbr-service-profile/"
  click FscloudMod "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/modules/fscloud/"
  click Ex1 "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/examples/fscloud/"
  click Ex2 "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/examples/multi-resource-rule/"
  click Ex3 "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/examples/multi-service-profile/"
  click Ex4 "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/examples/multizone-rule/"
  click Ex5 "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/examples/update-existing-zone-addresses/"
  click Ex6 "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/examples/zone/"
  click Tests "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/tree/main/tests/"
  click RootTF "https://github.com/terraform-ibm-modules/terraform-ibm-cbr/blob/main/main.tf"

  classDef code fill:#E3F2FD,stroke:#2196F3
  classDef ci fill:#FFF3E0,stroke:#FB8C00
  classDef runtime fill:#E8F5E9,stroke:#388E3C
```
