Jon Chery
d830357230
---ci--- project: acdl phase: 21 milestone: v1.6 status: execute ---/ci--- Restructure docs/ into a Jekyll-style GitHub Pages site: - docs/_config.yml (Pages config + nav, excludes internal/) - docs/index.md (landing: platform + consumer model, Features, Roadmap) - docs/modules/index.md (catalog: primitives + modules, normalized terms) - docs/contracts/index.md (schema, fields, sample, multi-contract) - docs/pipeline/index.md (CI + deploy pipeline, stages mermaid, streaming) - docs/pipeline/versioning.md (module + deploy-pipeline versioning) - docs/environments/index.md (platform-managed envs + onboarding, REQ-61) - docs/consumer-guide.md (renamed from CONSUMER_GUIDE.md; GitHub-only, no .gitea, forge->platform runners, L2->modules, composition->pattern, updated mermaid with security-checks + infrastructure-apply) - docs/architecture.md (consolidated from architecture.md + architecture-v1.0.md, current-architecture only, normalized terms: primitives/modules, platform runners, no L1/L2/forge/gitea in prose) - Removed docs/architecture-v1.0.md (consolidated) + docs/CONSUMER_GUIDE.md (renamed). No .ciagent/ or .gitea/ references in docs/. Consumer-facing terminology normalized (L2->modules, L1->primitives, composition->pattern, forge-> platform runners).
52 lines
3.1 KiB
Markdown
52 lines
3.1 KiB
Markdown
# Modules
|
|
|
|
Reusable building blocks for cloud infrastructure. There are two kinds:
|
|
|
|
- **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.
|
|
- **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 compiles a module instance to infrastructure. Each
|
|
module's README documents which resources it creates.
|
|
|
|
## Primitives
|
|
|
|
| Module | What it creates | Source |
|
|
|--------|----------------|--------|
|
|
| `s3` | `aws_s3_bucket` — a single S3 bucket | [modules/l1/s3/README.md](https://github.com/acdl/acdl/blob/main/modules/l1/s3/README.md) |
|
|
| `vpc` | `aws_vpc` + `aws_subnet` + `aws_route_table` + `aws_internet_gateway` — VPC with subnets and routing | [modules/l1/vpc/README.md](https://github.com/acdl/acdl/blob/main/modules/l1/vpc/README.md) |
|
|
| `ecs-cluster` | `aws_ecs_cluster` — ECS Fargate cluster | [modules/l1/ecs-cluster/README.md](https://github.com/acdl/acdl/blob/main/modules/l1/ecs-cluster/README.md) |
|
|
| `ecs-service` | `aws_ecs_task_definition` + `aws_ecs_service` — Fargate service with task definition | [modules/l1/ecs-service/README.md](https://github.com/acdl/acdl/blob/main/modules/l1/ecs-service/README.md) |
|
|
| `iam-role` | `aws_iam_role` — IAM role with assume-role policy | [modules/l1/iam-role/README.md](https://github.com/acdl/acdl/blob/main/modules/l1/iam-role/README.md) |
|
|
| `alb` | `aws_lb` + `aws_lb_target_group` + `aws_lb_listener` — Application Load Balancer | [modules/l1/alb/README.md](https://github.com/acdl/acdl/blob/main/modules/l1/alb/README.md) |
|
|
| `ecr` | `aws_ecr_repository` — ECR container image repository | [modules/l1/ecr/README.md](https://github.com/acdl/acdl/blob/main/modules/l1/ecr/README.md) |
|
|
|
|
## Modules
|
|
|
|
| Module | What it references | Source |
|
|
|--------|--------------------|--------|
|
|
| `static-asset` | 1 primitive (s3) — a static-asset S3 bucket | [modules/l2/static-asset/README.md](https://github.com/acdl/acdl/blob/main/modules/l2/static-asset/README.md) |
|
|
| `microservice` | 6 primitives (vpc, cluster, ecr, iam-role, alb, ecs-service) — an ECS Fargate microservice | [modules/l2/microservice/README.md](https://github.com/acdl/acdl/blob/main/modules/l2/microservice/README.md) |
|
|
|
|
## Registry
|
|
|
|
Module versions are tracked in
|
|
[`registry.json`](https://github.com/acdl/acdl/blob/main/modules/registry.json).
|
|
Both primitives and modules are registered.
|
|
|
|
## Versioning
|
|
|
|
Primitives and modules use semver: interface → MAJOR, behavior → MINOR,
|
|
lifecycle → PATCH. A MAJOR bump requires a new registry entry (immutable
|
|
publication); the old entry enters a 12-month deprecation window. See
|
|
[Versioning](../pipeline/versioning) for the deploy-pipeline versioning.
|
|
|
|
## 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. |