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

examples

feat(P27): validated per-module examples (D-058) + schema glob fix

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

composition.json

review(v1.5): READY TO SHIP — multi-persona code review

2026-07-22 17:24:28 +00:00

README.md

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

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

README.md

microservice — ECS Fargate microservice

Module kind: module pattern | Version: 1.0.0

A pattern that references multiple primitives to deploy an ECS Fargate microservice end-to-end (VPC, cluster, ECR, IAM role, ALB, ECS service).

Resources

The pattern references these primitives:

Primitive	Purpose	README
`vpc`	VPC, subnets, routing	README
`ecs-cluster`	ECS Fargate cluster	README
`ecr`	ECR image repository	README
`iam-role`	IAM task execution role	README
`alb`	Application Load Balancer	README
`ecs-service`	ECS task definition + service	README

Inputs

Name	Type	Required	Description
`image`	string	yes	ECR image URL for the task container
`port`	number	yes	Container port the service listens on
`region`	string	yes	AWS region
`cidr`	string	no	VPC CIDR block (default 10.0.0.0/16)
`azs`	string	no	Comma-separated availability zones

Outputs

Name	Type	Description
`lb_arn`	arn	The load balancer ARN
`service_arn`	arn	The ECS service ARN

Usage

Define a contract referencing this module:

uses: acdl/pipelines/deploy.yaml@v1.6
module: microservice
environment: dev
inputs:
  image: 581513795199.dkr.ecr.us-east-1.amazonaws.com/acdl-microservice:latest
  port: 8080
  region: us-east-1

Compliance extension points

The pattern can wire compliance resources across primitives when the compliance milestone (GDPR, SOX, SOC2, HIPAA, DORA) lands:

KMS key — shared encryption key referenced by S3, ECR, CloudWatch Logs, and Secrets Manager.
CloudTrail — management-plane audit trail for the entire stack.
VPC Flow Logs — network audit trail.
Security groups — proper network segmentation between ALB, service, and data tiers.
Private subnets — ECS tasks in private subnets with NAT egress.

See each primitive's README for per-module compliance extension points.

Examples

Validated example contracts are in examples/. The platform-test pipeline validates them against schemas/contract.schema.json.

Simple

A minimal deployment (minimal Fargate, no ALB):

examples/simple.yaml

# Simple microservice deployment (minimal Fargate, no ALB)
uses: acdl/pipelines/deploy.yaml@v1.6
module: microservice
environment: dev
inputs:
  bucket_name: my-microservice-demo
  region: us-east-1
  image: public.ecr.aws/docker/library/nginx:latest
  port: 80

Complex

A production deployment with optional inputs (ALB + env vars + health check):

examples/complex.yaml

# Complex microservice with ALB + env vars + health check
uses: acdl/pipelines/deploy.yaml@v1.6
module: microservice
environment: dev
inputs:
  bucket_name: my-production-microservice
  region: us-east-1
  image: public.ecr.aws/docker/library/nginx:latest
  port: 8080
  env:
    LOG_LEVEL: info
    ENVIRONMENT: production

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.