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.
78 lines
3.4 KiB
Markdown
78 lines
3.4 KiB
Markdown
# ecs-service — ECS Fargate service (task definition + service)
|
|
|
|
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
|
|
|
An ECS Fargate service with its task definition. Runs a container image
|
|
on Fargate, optionally behind an ALB target group. This is a
|
|
multi-resource module: it creates a task definition and a service that
|
|
runs it.
|
|
|
|
## Resources
|
|
|
|
| Resource | Type | Purpose |
|
|
|----------|------|---------|
|
|
| task_definition | `aws_ecs_task_definition` | Fargate task definition with container image, CPU, memory, port, env |
|
|
| service | `aws_ecs_service` | Fargate service running the task definition in a cluster + subnets |
|
|
|
|
## Inputs
|
|
|
|
| Name | Type | Required | Default | Description |
|
|
|------|------|----------|---------|-------------|
|
|
| `image` | string | yes | — | ECR image URL for the task container |
|
|
| `port` | number | yes | — | Container port the service listens on |
|
|
| `cpu` | number | no | 256 | Task CPU units (Fargate) |
|
|
| `memory` | number | no | 512 | Task memory in MiB (Fargate) |
|
|
| `env` | string | no | — | Environment variables as a JSON map string |
|
|
| `cluster_arn` | arn | yes | — | ECS cluster ARN (from `ecs-cluster`) |
|
|
| `subnets` | string | yes | — | Comma-separated subnet ids (from `vpc`) |
|
|
| `security_group` | string | yes | — | Security group id for the service ENIs |
|
|
| `lb_target_group_arn` | arn | no | — | Optional ALB target group ARN (from `alb`) |
|
|
| `region` | string | yes | — | AWS region the service is created in |
|
|
|
|
## Outputs
|
|
|
|
| Name | Type | Description |
|
|
|------|------|-------------|
|
|
| `service_arn` | arn | The ECS service ARN |
|
|
| `task_def_arn` | arn | The ECS task definition ARN |
|
|
|
|
## Usage
|
|
|
|
```json
|
|
{
|
|
"id": "service",
|
|
"type": "aws:ecs:task_definition",
|
|
"module": "ecs-service@1.0.0",
|
|
"inputs": {
|
|
"image": "581513795199.dkr.ecr.us-east-1.amazonaws.com/acdl-microservice:latest",
|
|
"port": 8080,
|
|
"cpu": 256,
|
|
"memory": 512,
|
|
"cluster_arn": "ref:cluster.cluster_arn",
|
|
"subnets": "ref:vpc.subnet_ids",
|
|
"security_group": "ref:roles.role_arn",
|
|
"region": "us-east-1"
|
|
}
|
|
}
|
|
```
|
|
|
|
The `image`, `port`, and `env` inputs are compiled into a
|
|
`container_definitions` JSON block by the adapter. The service is
|
|
placed in the cluster with the given subnets and security group, and
|
|
optionally wired to the ALB target group if `lb_target_group_arn` is
|
|
provided.
|
|
|
|
## Compliance extension points
|
|
|
|
- **CloudWatch Logs** — add `logConfiguration` to the container definition with a log group + retention policy (SOX, SOC2 CC7.2, HIPAA §164.312(b), DORA ICT incident logging).
|
|
- **Task execution role separation** — add a separate `aws_iam_role` for execution vs. the task role (SOC2 CC6.3 segregation of duties at runtime).
|
|
- **Secrets injection** — add `secrets` block referencing AWS Secrets Manager / SSM Parameter Store with KMS encryption (SOC2 CC6.1, HIPAA §164.312(a)(2)(iv)).
|
|
- **Execute command** — add `enable_execute_command` with KMS encryption for session audit (SOC2 CC7.2).
|
|
- **Deployment circuit breaker** — add `deployment_circuit_breaker` block for resilience (SOC2 CC9.1, DORA operational resilience).
|
|
- **Health check** — add a `health_check` block to the target group (currently missing despite the contract schema having a healthcheck field).
|
|
|
|
## Versioning
|
|
|
|
`1.0.0` — interface MAJOR, behavior MINOR, lifecycle PATCH. MAJOR bumps
|
|
require a new registry entry (immutable publication); old entries enter
|
|
a 12-month deprecation window. |