Jon Chery
f68f85c9fd
---ci---
project: acdl
phase: 20
milestone: v1.5
status: review
verdict: READY TO SHIP
p0: 1 (fixed — contract path resolution in deploy workflow)
p1: 6 (flagged post-hoc)
---/ci---
Multi-persona review of v1.5 phase 20 (docs + reusable deploy workflow).
P0 (blocking) — AUTO-FIXED:
- C1: scripts/run_platform.sh contract path resolution broken in deploy
workflow. The reusable workflow invokes run_platform.sh from the consumer
workspace root with a relative contract path (.acdl/contract.yaml), but
run_platform.sh does `cd "$ROOT"` (platform repo) early, so the relative
path resolved against the platform repo and the pipeline could never run.
Fix (commit 75c2274): capture CALLER_CWD before cd "$ROOT"; resolve
caller-supplied relative paths against CALLER_CWD; default no-arg contract
stays relative to ROOT (preserves platform-local CI). Reproduced pre-fix;
verified post-fix.
P1 (important) — FLAGGED FOR POST-HOC REVIEW (do not block ship):
- C2: ref: v1.4 in the deploy workflow platform checkout — no v1.4 tag exists
(only v1.4.0 / v1.4.1). Operator must create a floating v1.4 tag or change
the ref to v1.4.1.
- C3: modules/l2/{static-asset,microservice}/README.md still use @v1 in their
Usage examples; missed by the v1.4 bump.
- S1: static-key override is not wired. ACDL_AWS_* env vars on the OIDC step
are not read by aws-actions/configure-aws-credentials@v4 (it reads AWS_*
or its own access-key/secret-key inputs). The README/CONSUMER_GUIDE claim
a working override that doesn't function as written. Needs a conditional
step or renamed env vars + input wiring.
- S2: README overstates ABAC repo:org/repo:ref:... scoping. The workflow
constructs a numeric role name (github.repository_id); the actual claim
enforcement lives in the IAM trust policy, not in this workflow.
- T1: no deploy-workflow triggers conformance test (CI workflow has one;
deploy doesn't). Minor — reusable workflows use workflow_call, not push
triggers, but the contract's triggers field is then unenforced.
- A1: terraform/spike/terraform.tf uploaded as artifact leaks the AWS account
ID via the state-backend bucket name. Recommend excluding terraform.tf or
gating artifact upload to non-public repos.
P2 (nits) — listed for awareness: floating-tag terminology imprecision (M1),
header comment "Gitea Actions" in the GitHub copy (M2, intentional byte-
identical), pip install split (P1-perf), comment drift in pipelines/deploy.yaml
header (C4), module README internal inconsistency (C5).
Verdict: READY TO SHIP. The one P0 is fixed. The 6 P1s are post-hoc items —
the deploy workflow is a scaffold whose first real consumer run requires
operator setup (tag, IAM role, secrets) that gates go-live. The P1s should
be addressed before any consumer invokes uses: acdl/.gitea/workflows/
deploy.yml@v1.4 in earnest.
Tests: 154 pass (19 new). run_ci.sh green.
2.1 KiB
2.1 KiB
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:
- L1 primitives — a single cloud resource or a small group of
related resources (e.g. a VPC with subnets and routing). Each L1 has
an
interface.jsondeclaring its inputs and outputs, and aREADME.mdin plain language. - L2 compositions — a composition that references multiple L1s to
deploy a complete stack (e.g. an ECS Fargate microservice). Each L2
has a
composition.jsondeclaring its children and wires.
The Terraform adapter (adapters/terraform/adapter.py) compiles a
module instance to Terraform. Each module's README documents which
Terraform resources it creates.
L1 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 |
L2 compositions
| Module | What it references | README |
|---|---|---|
microservice |
6 L1s (vpc, cluster, ecr, iam-role, alb, ecs-service) | README |
static-asset |
1 L1 (s3) | README |
Registry
Module versions are tracked in registry.json. Both L1 and L2 entries
are registered.
Template
New modules should use README-TEMPLATE.md as their starting point.