Files

T

Jon Chery 94065a4fbc feat(P27): add Examples section to every module README (D-058)

Each module README (10 primitives + 2 patterns) now has a ## Examples
section before ## Versioning, referencing and excerpting the validated
simple.yaml + complex.yaml (+ mysql.yaml for RDS) example contracts. The
RDS README includes a Multi-engine variation subsection (D-059).

---ci---
project: acdl
phase: 27
milestone: v1.7
status: execute
---/ci---

2026-07-22 20:23:48 +00:00

feat(P27): add Examples section to every module README (D-058)

2026-07-22 20:23:48 +00:00

feat(P27): add Examples section to every module README (D-058)

2026-07-22 20:23:48 +00:00

.gitkeep

docs(P20): specify phase 20 — consumer happy path + reusable deploy workflow (v1.5)

2026-07-22 17:09:23 +00:00

README-TEMPLATE.md

docs(P21): rewrite README + normalize modules terminology (REQ-52,55,56,57,58,59,60)

2026-07-22 18:26:00 +00:00

README.md

feat(P22): rename static-asset→static-assets + cloudfront/waf primitives + production stack + @v1.6 bump

2026-07-22 19:56:52 +00:00

registry.json

feat(P27): RDS primitive + adapter expansion (D-059)

2026-07-22 20:21:45 +00:00

README.md

ACDL Modules

Reusable building blocks for cloud infrastructure. Each module is self-documented with a README.md following the template.

How the modules work

There are two kinds of module:

Primitives — a single cloud resource or a small group of related resources (e.g. a VPC with subnets and routing). Each primitive has an interface.json declaring its inputs and outputs, and a README.md in plain language.
Modules — a pattern that references multiple primitives to deploy a complete stack (e.g. an ECS Fargate microservice). Each module has a composition.json declaring its children and wires.

The substrate adapter (adapters/terraform/adapter.py) compiles a module instance to infrastructure. Each module's README documents which resources it creates.

Primitives

Module	What it creates	README
`s3`	`aws_s3_bucket` — a single S3 bucket	README
`vpc`	`aws_vpc` + `aws_subnet` + `aws_route_table` + `aws_internet_gateway` — VPC with subnets and routing	README
`ecs-cluster`	`aws_ecs_cluster` — ECS Fargate cluster	README
`ecs-service`	`aws_ecs_task_definition` + `aws_ecs_service` — Fargate service with task definition	README
`iam-role`	`aws_iam_role` — IAM role with assume-role policy	README
`alb`	`aws_lb` + `aws_lb_target_group` + `aws_lb_listener` — Application Load Balancer	README
`ecr`	`aws_ecr_repository` — ECR container image repository	README
`cloudfront`	`aws_cloudfront_distribution` + `aws_cloudfront_origin_access_control` — CloudFront distribution with S3 origin via OAC	README
`waf`	`aws_wafv2_web_acl` — WAFv2 Web ACL (CloudFront-scoped)	README

Modules

Module	What it references	README
`microservice`	6 primitives (vpc, cluster, ecr, iam-role, alb, ecs-service)	README
`static-assets`	3 primitives (s3, cloudfront, waf)	README

Registry

Module versions are tracked in registry.json. Both primitives and modules are registered.

Template

New modules should use README-TEMPLATE.md as their starting point.

Module patterns (roadmap)

The current composition.json mechanism is a thin pattern layer. A future redesign will let a consumer dynamically create a module directly from the contract file (an agentic "composition" flow). That is on the roadmap, not implemented today.