How terraform-ibm-modules/terraform-ibm-cbr works
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